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
Philip Molares
9c2e47dcc4
Docs: Add configuration documentation
...
This adds documentation for the configuration of HedgeDoc.
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-04-25 17:29:53 +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
67e1ff3d07
Documentation: Add toggleable dark theme
...
The dark theme is mostly built on top of the mkdocs slate theme.
Signed-off-by: Philip Molares <philip.molares@udo.edu>
Co-Authored-by: Tilman Vatteroth <git@tilmanvatteroth.de>
(cherry picked from commit 60251d89ee
2021-04-17 12:42:03 +02:00
Philip Molares
892a66543e
Documentation: Add WebDAV media guide
...
This explains how to use the WebDAV media backend both in general and with a NextCloud in particular.
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-04-16 13:23:09 +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
Philip Molares
f78b857aef
Docs: Add footnotes extension
...
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-03-28 20:24:45 +02:00
Philip Molares
c272f1e702
Docs: Add hedgedoc flavored markdown reference
...
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-03-25 22:20:45 +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
Philip Molares
d173ff11e5
Docs: Fix dev doc 'documentation'
...
Fix typos
Rewrite 'Deployment' paragraph. We currently don't and probably won't use Messor Structor.
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-03-20 13:18:06 +01:00
David Mehren
d7491f0ce0
Add dev docs about deleting notes & revisions
...
Fixes #560
Signed-off-by: David Mehren <git@herrmehren.de>
2021-03-15 11:53:44 +01:00
Philip Molares
e177d40ba5
DevDocs: Add explanations for new config modules
...
The new config modules `customization` and `external-services` are explained in the dev doc overview of all config modules now.
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-03-20 13:29:39 +01:00
Philip Molares
6e29ffba65
MediaService: Remove allowedMimeType application/pdf
...
Uploading PDFs does not work with imgur and therefore HedgeDoc should not offer that.
See #533
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-03-15 22:41:40 +01:00
Yannick Bungers
f47d85b301
Add GET /me/media
...
Returns all media files uploaded by the authenticated user.
Signed-off-by: Yannick Bungers <git@innay.de>
2021-03-14 17:47:16 +01:00
Philip Molares
bb6d34c88c
Docs: Add Azure, Filesystem, Imgur and S3
...
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-02-28 17:46:00 +01:00
Philip Molares
95b3c628ce
DBSchema: Add fileUrl to media_upload table
...
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-02-27 11:24:41 +01:00
Yannick Bungers
b1616ea854
Docs: Add description for special groups
...
Signed-off-by: Yannick Bungers <git@innay.de>
2021-02-27 14:16:29 +01:00
Yannick Bungers
8873ac316a
Rename viewcount to viewCount for compliance
...
Signed-off-by: Yannick Bungers <git@innay.de>
2021-02-22 23:36:44 +01:00
David Mehren
54a26ae751
Document supported databases in 2.0
...
Closes #447
Signed-off-by: David Mehren <git@herrmehren.de>
2021-02-19 12:50:16 +01:00
David Mehren
f7607fae54
Add intention of 2.0 development docs
...
Signed-off-by: David Mehren <git@herrmehren.de>
2021-02-19 12:43:55 +01:00
Yannick Bungers
68cbb5a9c2
Add relation between User and Group
...
This represents the users which are members of this group
Signed-off-by: Yannick Bungers <git@innay.de>
2021-01-27 22:58:55 +01:00
Philip Molares
8a33f75cf9
Docs: Add interface documentation for the toolbar
...
This documentation explains HedgeDoc's toolbar to new users.
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-01-10 21:51:08 +01:00
Philip Molares
07dc15b127
Dev Docs: Add configuration to navigation
...
This makes it possible to access the developer documentation about configuration code.
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-02-03 20:58:16 +01:00
Philip Molares
57f76499f0
Dev Docs: Add configuration documentation
...
This explains how the configuration code works and give some hints on what do look out for while working on the configuration code.
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-02-03 20:50:49 +01:00
Philip Molares
300b464efd
History: Add HistoryEntry
...
With this the backend now can hold a history entry.
Also included in this commit are some minor changes to tests and services so they can still work.
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-02-03 21:15:39 +01:00
David Mehren
2ee8ff4d91
Update docs with hint about 2.0 development
...
Replace the old docs index page with a hint where the (for now) 'real'
docs can be found and that HedgeDoc 2.0 is still in development.
Signed-off-by: David Mehren <git@herrmehren.de>
2021-02-04 21:50:38 +01:00
David Mehren
effba43fe8
Delete old docs not relevant for 2.x
...
Signed-off-by: David Mehren <git@herrmehren.de>
2021-02-04 16:14:59 +01:00
Philip Molares
8f008c7cc5
auth: Add cron to clean old tokens
...
Rename AuthToken.identifier to label
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-01-24 20:37:04 +01:00
Philip Molares
c9751404f7
tokens: Add token creation
...
Fix token deletion
Update plantuml docs
Add token validUntil and lastUsed fields
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-01-21 19:37:43 +01:00
Philip Molares
c232707a89
db-schema: updates plantuml
...
adds identifier and createdAt to AuthToken
renames authToken in User to authTokens
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-01-17 14:49:28 +01:00
Yannick Bungers
5246f0c05d
Removed special table name in Note object
...
and changed table names in plantuml file
Signed-off-by: Yannick Bungers <git@innay.de>
2021-01-23 00:41:49 +01:00
David Mehren
a14056dbc9
Move note permission route under metadata
...
Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-10 20:25:28 +01:00
Philip Molares
503639733c
Fix some typos in history.md
...
(cherry picked from commit 0195d074a8
2020-12-01 00:32:48 +01:00
Simon C
3ef987d293
docs: Fix indentation of code
2021-01-08 14:58:01 +01:00
