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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Erik Michelson
c917e9d5f1
Update name in docs
...
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2022-02-14 11:50:02 +01:00
Chasethechicken
5b8b731004
Correct documentation on how to access Hedgedoc
...
Signed-off-by: Falk Rehse <neuringe1234@gmail.com>
2021-12-21 10:37:11 +01:00
Chasethechicken
ec4d539c99
Apply suggestions from code review
...
Use real backend by default.
Start server with NODE_ENV set to development mode.
Co-authored-by: David Mehren <git@herrmehren.de>
Signed-off-by: Falk Rehse <neuringe1234@gmail.com>
2021-12-15 22:22:11 +01:00
Falk Rehse
30ab3e3831
Improve wording
...
Signed-off-by: Falk Rehse <neuringe1234@gmail.com>
2021-12-14 11:53:26 +01:00
Chasethechicken
9af0d85879
Remove paragraph about development setup
...
As this is documented in dev/getting-started.md
Signed-off-by: Falk Rehse <neuringe1234@gmail.com>
2021-12-14 11:38:43 +01:00
Chasethechicken
c61b4bdbf2
Add note about proxy
...
Signed-off-by: Falk Rehse <neuringe1234@gmail.com>
2021-12-14 11:37:37 +01:00
Chasethechicken
19bd892c69
Remove section about production deployments
...
As this is meant to document a development setup.
Signed-off-by: Falk Rehse <neuringe1234@gmail.com>
2021-12-14 11:37:12 +01:00
Chasethechicken
6a1704a45b
Add Docs for getting started with 2.0
...
This page describes how to set up HedgeDoc 2 for local development.
Signed-off-by: Falk Rehse <neuringe1234@gmail.com>
2021-10-31 00:56:54 +02:00
David Mehren
708ae86444
docs: explain the choice of sha-512 for auth tokens
...
Signed-off-by: David Mehren <git@herrmehren.de>
2021-12-14 19:21:28 +01:00
Philip Molares
d0239f3a24
docs: add dev documentation for create methods
...
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-11-11 22:07:00 +01:00
Philip Molares
1e3071516b
docs: add primary aliases to the dev doc about notes
...
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-06-06 18:07:53 +02:00
Philip Molares
17c55195c3
feat: add list of aliases to note entity
...
One of the aliases can be primary for each note, but all can be used to get information from the apis.
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-06-06 17:46:32 +02:00
Philip Molares
23e26fb830
chore: move identity entity in its own folder
...
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-08-08 21:53:20 +02:00
Philip Molares
d6be1cc6bb
docs: add documentation on private api authentication
...
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-08-08 20:21:16 +02:00