Commit graph

338 commits

Author SHA1 Message Date
Philip Molares
a44e364553 docs(imgur): add warning about new imgur policy
Because imgur will delete images 6 month after the last access, we should tell our users about this change to help them make a informed decision about their media backend choice…

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2023-05-07 22:42:58 +02:00
renovate[bot]
fc00b39234 chore(deps): update dependency mkdocs to v1.4.3
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-05-03 02:12:47 +00:00
renovate[bot]
55272ed2b9 chore(deps): update dependency mkdocs-material to v9.1.9
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-05-02 12:10:35 +02:00
renovate[bot]
f2c1aade4e chore(deps): update dependency mkdocs-material to v9.1.8
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-04-25 09:31:38 +02:00
renovate[bot]
08fdc8cd0a chore(deps): update dependency mkdocs-material to v9.1.7
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-04-22 18:11:34 +00:00
Tilman Vatteroth
d8c1e35819 docs(docs): make clear that the s3 endpoint must be a URL
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2023-04-16 18:41:03 +02:00
Tilman Vatteroth
476aff890e fix: usage of .env file in getting-started dev guide
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2023-04-13 10:39:17 +02:00
renovate[bot]
7056f137dc chore(deps): update dependency pymdown-extensions to v9.11
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-04-07 22:35:00 +02:00
renovate[bot]
3e3b46a81b chore(deps): update dependency mkdocs-material to v9.1.6
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-04-07 22:20:08 +02:00
renovate[bot]
c1f83cb699 chore(deps): update dependency mkdocs-material to v9.1.5
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-03-31 09:56:23 +00:00
David Mehren
57701b5d6c docs: add note about separate renderer domain
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-26 15:53:49 +02:00
David Mehren
80eb4c8a1a docs: change default session secret in docker deployment
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-26 15:53:49 +02:00
David Mehren
f7f052fca1 refactor: use separate env vars for frontend/backend port
As we moved to a combined .env file for simplicity, frontend and backend need to be configured with separate variables.

Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-26 15:53:49 +02:00
David Mehren
b538c2c2a3 docs: minor fixes for config docs
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-25 13:05:42 +01:00
David Mehren
520d0933cb docs: add getting started guide
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-25 13:05:42 +01:00
David Mehren
26da4c6327 docs: consistent Markdown formatting
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
David Mehren
31969c56eb docs: add missing design docs disclaimer
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
David Mehren
b5e64880cd docs: Add docker docs to navbar
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
David Mehren
c278f6d78b docs: Split up 2.0.md and rename to dev_notes.md
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
David Mehren
bec48f3c22 docs: Add frontend docs to navbar
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
David Mehren
3c957e9b0e docs: Move 'Events' to design docs
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
David Mehren
58f306a38c docs: Merge API Authentication docs
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
David Mehren
1093da4a39 docs: Move 'Notes' to design docs
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
David Mehren
c9f8285f57 docs: Move 'Configuration' to design docs
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
David Mehren
162a8e8816 docs: Move 'User Profiles & Authentication' to design docs
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
David Mehren
8bb39b8c6d docs: introduce 'Design Documents' category
These documents provide context for various application aspects.

This commit also fixes the indentation and missing lists in the mkdocs config.

Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
renovate[bot]
4707540237 chore(deps): update dependency mkdocs-material to v9.1.4
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-03-24 15:36:21 +01:00
renovate[bot]
df1ef869c9 chore(deps): update dependency mkdocs-material to v9.1.3
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-03-14 20:46:10 +01:00
renovate[bot]
9f58da017f chore(deps): update dependency mkdocs-material to v9.1.2
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-03-11 09:14:23 +01:00
renovate[bot]
4f2415c311 chore(deps): update dependency pymdown-extensions to v9.10
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-03-05 18:58:00 +01:00
renovate[bot]
c88b3830e0 chore(deps): update dependency mkdocs-material to v9.1.1
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-03-05 18:42:07 +01:00
renovate[bot]
ec28a04ad2 chore(deps): update dependency mkdocs-material to v9.0.15
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-02-26 12:56:41 +01:00
Tilman Vatteroth
6705e1350f docs: Remove node 14 from getting-started.md
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2023-02-25 21:06:36 +01:00
renovate[bot]
3b1795d854 chore(deps): update dependency mkdocs-material to v9.0.14
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-02-25 13:47:37 +01:00
Philip Molares
1c16e25e14 feat(frontend): replace forkawesome with bootstrap icons
These icon replace fork awesome. A linter informs the user about the deprecation.

See https://github.com/hedgedoc/hedgedoc/issues/2929

Co-authored-by: Philip Molares <philip.molares@udo.edu>
Co-authored-by: Tilman Vatteroth <git@tilmanvatteroth.de>
Signed-off-by: Philip Molares <philip.molares@udo.edu>
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2023-02-24 14:31:17 +01:00
Tilman Vatteroth
e7246f1484 fix(docs): reformat hfm.md
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2023-02-22 17:02:25 +01:00
renovate[bot]
d5645c7bfd chore(deps): update dependency mkdocs-material to v9.0.13
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-02-18 20:02:27 +01:00
Tilman Vatteroth
57bfca7b15 fix(frontend): refactor api error handling
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2023-02-12 22:10:31 +01:00
renovate[bot]
c6735be7d0 chore(deps): update dependency mkdocs-material to v9.0.12
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-02-11 09:29:26 +01:00
Erik Michelson
305b6f5910 misc: add turbo monorepo util
Co-authored-by: Tilman Vatteroth <git@tilmanvatteroth.de>
Co-authored-by: David Mehren <git@herrmehren.de>
Co-authored-by: Erik Michelson <github@erik.michelson.eu>
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
Signed-off-by: David Mehren <git@herrmehren.de>
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2023-02-07 21:38:40 +01:00
Tilman Vatteroth
5e1fdbe81d fix(config): Replace HD_DOMAIN and HD_EDITOR_BASE_URL with HD_BASE_URL
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2023-02-05 22:32:31 +01:00
Tilman Vatteroth
352de8e7b9 feat(doc): Add docker docs
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2023-02-05 21:21:08 +01:00
renovate[bot]
43a976f763 chore(deps): update dependency mkdocs-material to v9.0.11
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-02-04 13:57:06 +01:00
renovate[bot]
93899ca896 chore(deps): update dependency mkdocs-material to v9.0.8
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-01-29 19:10:19 +01:00
renovate[bot]
d12a3e7b18 chore(deps): update dependency mkdocs-material to v9.0.7
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-01-28 16:34:02 +00:00
Yannick Bungers
61e4e846b0 docs: Restructure getting-started.md and add quick start for development
Signed-off-by: Yannick Bungers <git@innay.de>
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2023-01-24 22:43:23 +01:00
renovate[bot]
ddcd046622 chore(deps): update dependency pymdown-extensions to v9.9.2
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-01-21 23:07:19 +01:00
renovate[bot]
6b3da367be chore(deps): update dependency mkdocs-material to v9.0.6
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-01-21 21:07:38 +00:00
renovate[bot]
13316d3e1a chore(deps): update dependency pymdown-extensions to v9.9.1
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-01-15 19:00:31 +01:00
renovate[bot]
788d7377a2 chore(deps): update dependency mkdocs-material to v9.0.5
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-01-15 18:37:20 +01:00
renovate[bot]
51090d19c1 chore(deps): update dependency mkdocs-material to v9
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2023-01-08 16:27:49 +01:00
Tilman Vatteroth
60db7f4931 fix(docs): Adjust getting started docs
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2022-12-11 23:09:10 +01:00
renovate[bot]
d4e5252596 chore(deps): update dependency pymdown-extensions to v9.9
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-12-04 21:37:21 +01:00
renovate[bot]
7fe9df3994 chore(deps): update dependency mkdocs-material to v8.5.11
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-12-03 07:09:36 +00:00
Tilman Vatteroth
d5dfbb575a
fix(docs): adjust frontend and reverse proxy docs
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2022-11-20 21:49:56 +01:00
renovate[bot]
2034f4e52b chore(deps): update dependency pymdown-extensions to v9.8
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-11-20 18:31:58 +01:00
renovate[bot]
2ab1ac4eae chore(deps): update dependency mkdocs-material to v8.5.10
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-11-12 07:30:56 +00:00
renovate[bot]
2ae47c8788 chore(deps): update dependency mkdocs to v1.4.2
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-11-06 22:33:31 +01:00
renovate[bot]
94b5c0362a chore(deps): update dependency mkdocs-material to v8.5.8
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-11-06 22:20:18 +01:00
Tamotsu Takahashi
af0b34efa1 Update HD_DATABASE_*
Fix leftovers from #2278 cd5256da7f

Signed-off-by: Tamotsu Takahashi <ttakah+github@gmail.com>
2022-10-30 16:44:42 +01:00
renovate[bot]
702a69d4bc chore(deps): update dependency pymdown-extensions to v9.7
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-10-23 21:19:09 +02:00
renovate[bot]
ec9797d154 chore(deps): update dependency mkdocs-material to v8.5.7
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-10-22 12:14:32 +02:00
renovate[bot]
9b64bdf034 chore(deps): update dependency mkdocs to v1.4.1
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-10-15 23:53:55 +00:00
Tilman Vatteroth
35032eef09 fix(frontend config): Remove origins from frontend configuration
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2022-10-03 19:24:56 +02:00
Philip Molares
c4e06cfe28 docs: add local auth
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2022-10-03 10:36:46 +02:00
Tilman Vatteroth
01d9168819 fix(docs): correct getting started dev documentation
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2022-10-02 21:34:54 +02:00
Philip Molares
5dffe35ea1 docs: add documentation about events
Signed-off-by: Philip Molares <philip.molares@udo.edu>
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2022-10-02 20:51:23 +02:00
renovate[bot]
846cc0b052 chore(deps): update dependency mkdocs-material to v8.5.6
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-10-02 18:31:09 +02:00
renovate[bot]
7ecbbaa920 chore(deps): update dependency mkdocs to v1.4.0
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-10-02 17:54:30 +02:00
renovate[bot]
9c90acbbb7 chore(deps): update dependency pymdown-extensions to v9.6
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-10-02 17:54:17 +02:00
renovate[bot]
4e86484a9d chore(deps): update dependency mkdocs-material to v8.5.5
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-10-01 18:34:43 +00:00
renovate[bot]
2f5c2a85a4 chore(deps): update dependency mkdocs-material to v8.5.3
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-09-24 12:31:04 +00:00
Philip Molares
df976b5fe1 feat(config): add config vars for default permissions for special groups
Co-authored-by: Tilman Vatteroth <git@tilmanvatteroth.de>
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2022-09-18 21:29:35 +02:00
renovate[bot]
c835339633 chore(deps): update dependency mkdocs-material to v8.5.2
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-09-18 19:14:21 +02:00
renovate[bot]
be7072f580 chore(deps): update dependency mkdocs-material to v8.4.4
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-09-17 18:17:37 +00:00
renovate[bot]
aadfa08e01 chore(deps): update dependency mkdocs-material to v8.4.3
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-09-10 13:40:13 +00:00
renovate[bot]
0312e85315 chore(deps): update dependency mkdocs-material to v8.4.2
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-08-27 14:24:38 +00:00
renovate[bot]
8431b541b4 chore(deps): update dependency mkdocs-material to v8.4.1
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-08-21 20:38:27 +00:00
renovate[bot]
8c5074cbc6 chore(deps): update dependency mkdocs-material to v8.4.0
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-08-15 11:08:58 +02:00
Tilman Vatteroth
4746c30c26 feat: persist notes on realtime note unload and on interval
The realtime note map has been moved into its own class
to separate the realtime note business logic from the storing logic.

Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2022-08-07 22:45:25 +02:00
Philip Molares
eb11545ca7 docs: fix some typos
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2022-08-01 17:27:00 +02:00
renovate[bot]
65eaa36532 chore(deps): update dependency mkdocs to v1.3.1
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-07-23 04:07:50 +00:00
renovate[bot]
8289eec784 chore(deps): update dependency mkdocs-material to v8.3.9
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-07-09 12:56:49 +00:00
renovate[bot]
baa81dd0c5 chore(deps): update dependency mkdocs-material to v8.3.8
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-06-25 11:32:41 +00:00
renovate[bot]
6a00010975 chore(deps): update dependency mkdocs-material to v8.3.6
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-06-18 21:03:33 +02:00
Renovate Bot
c0c3c974be chore(deps): update dependency pymdown-extensions to v9.5
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-06-12 20:22:34 +02:00
Renovate Bot
7764cc7d67 chore(deps): update dependency mkdocs-material to v8.3.4
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-06-11 20:30:47 +00:00
Renovate Bot
06deae08aa chore(deps): update dependency mkdocs-material to v8.3.2
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-06-05 15:13:50 +00:00
Renovate Bot
ded22d029f chore(deps): update dependency mkdocs-material to v8.3.1
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-06-04 18:39:29 +02:00
Philip Molares
f9f81cf348 chore: add .gitignore to docs
This prevents common folders used in the documentation process to be
considered by git.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2022-06-02 17:19:01 +02:00
Renovate Bot
d8212bafaa chore(deps): update dependency mkdocs-material to v8.2.16
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-05-28 19:04:53 +00:00
Renovate Bot
97068bcf3b chore(deps): update dependency mkdocs-material to v8.2.15
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-05-14 18:15:42 +00:00
Renovate Bot
d1cdb6ca27 chore(deps): update dependency mkdocs-material to v8.2.14
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-05-08 20:23:05 +02:00
Renovate Bot
c104dfe522 chore(deps): update dependency mkdocs-material to v8.2.13
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-05-07 12:19:48 +00:00
Renovate Bot
5f588cde62 chore(deps): update dependency pymdown-extensions to v9.4
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-05-01 21:05:15 +02:00
David Mehren
cd5256da7f refactor(db-config): Use typeorm-style options
TypeORM does not use a separate config option for the path
to the SQLite file.
Additionally, the "dialect" is called "type."

This commit adjusts our config to follow the upstream convention
to reduce confusion.

Signed-off-by: David Mehren <git@herrmehren.de>
2022-05-01 20:49:09 +02:00
Renovate Bot
a06a351659 chore(deps): update dependency mkdocs-material to v8.2.12
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-04-30 23:09:03 +00:00
Renovate Bot
933ebb9f22 chore(deps): update dependency mkdocs-material to v8.2.11
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-04-30 05:53:08 +00:00
Renovate Bot
2a48325787 chore(deps): update dependency mkdocs-material to v8.2.10
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-04-24 13:52:15 +00:00
Philip Molares
819dd8f568 docs(dev): add developer documentation about ldap
This explains how a developer is able to get a ldap server up and running and configure HedgeDoc to use it quickly.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2022-04-17 21:05:13 +02:00