Commit graph

72 commits

Author SHA1 Message Date
Philip Molares
d185e2e694 refactor: rename HD_AUTH_LDAPS to HD_AUTH_LDAP_SERVERS
This was done as LDAPS us both the plural of LDAP and the common abbreviation for secure LDAP connections.

Fixes #4460

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2023-07-22 11:37:17 +02:00
Philip Molares
e8e72c5328 docs: run lint:fix
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2023-07-09 20:07:07 +02:00
Philip Molares
50d4959e0a docs: run lint:fix
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2023-07-09 20:07:07 +02:00
Juned Khan
723c5752bd doc: Added documentation to enable debug logging in prod
Signed-off-by: Juned Khan <junedkhanc101@gmail.com>
2023-07-02 14:33:06 +02:00
Philip Molares
4bf2ca4ca7 docs: update ldap dev docs
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2023-05-12 21:11:45 +02:00
Tilman Vatteroth
23901d1454 chore: change recommended and CI node version to v20
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2023-05-10 13:43:05 +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
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
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
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
Philip Molares
eb11545ca7 docs: fix some typos
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2022-08-01 17:27:00 +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
David Mehren
fddb7e8c8c
Allow anonymous user colors in DB schema
Every authorship now has an author that saves the color.
The author links to the session and optionally the user.
For anonymous users, the session now can be used to reidentify the user.
 If the user is logged-in, the userId is saved into the author table.
 This allows to identify the user even after the session expired.

 A note created by an anonymous user does not have an owner.
 The cardinality was updated to reflect that.

Signed-off-by: David Mehren <git@herrmehren.de>
2021-04-29 18:07:06 +02:00
Philip Molares
92066d0746
chore(plantuml): Add publicId to note
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-05-16 22:54:45 +02:00
Philip Molares
f739687b00
Refactor(note): Remove shortid from note
This is a 1.x relict and isn't used anymore in 2.x. All 1.x shortids will be converted to aliases on migration of 1.x to 2.x.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-05-11 22:37:52 +02:00
Philip Molares
f99b157098
Docs: Fix mkdocs link
The link that was included in the reference was surrounded by paranthesis and therefore faulty.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-04-25 20:57:13 +02:00
Philip Molares
157d9bb21c
Add dev docs about notes
fixes #864

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-03-18 13:49:25 +01:00
David Mehren
2d05f0cd77
Add dev docs about user profiles and authentication
Closes #463
Closes #451
Signed-off-by: David Mehren <git@herrmehren.de>
2021-03-15 11:19:50 +01:00