Commit graph

212 commits

Author SHA1 Message Date
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
renovate[bot]
1c010ce3c2
chore(deps): update dependency mkdocs-material to v8.1.3 (#1922)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-12-19 15:10:41 +00:00
renovate[bot]
80b3b50a40
chore(deps): update dependency mkdocs-material to v8.1.2 (#1911)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-12-18 05:33:39 +00: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
Renovate Bot
06cccf1121
chore(deps): update dependency mkdocs-material to v8.1.0
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-12-11 10:42:06 +00:00
renovate[bot]
72d334c32a
chore(deps): update dependency mkdocs-material to v8.0.5 (#1892)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-12-11 05:00:44 +00:00
Renovate Bot
8031efce89
chore(deps): update dependency mkdocs-material to v8
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-12-05 17:55:24 +00: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
Renovate Bot
299be9af1e
chore(deps): update dependency pymdown-extensions to v9.1
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-11-14 17:38:06 +00:00
renovate[bot]
79eba2b3f3
chore(deps): update dependency mkdocs-material to v7.3.6 (#1792)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-10-30 14:11:19 +00:00
renovate[bot]
68a71e9b18
chore(deps): update dependency mkdocs-material to v7.3.5 (#1786)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-10-28 00:32:07 +00:00
renovate[bot]
6e168cb579
chore(deps): update dependency mkdocs-material to v7.3.4 (#1756)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-10-19 06:59:37 +00:00
Renovate Bot
263de45748
chore(deps): update dependency pymdown-extensions to v9
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-10-13 18:54:35 +00:00
Renovate Bot
11da01e090
chore(deps): update dependency mkdocs to v1.2.3
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-10-13 18:37:24 +00:00
renovate[bot]
e0cf190ba4
chore(deps): update dependency mkdocs-material to v7.3.3 (#1727)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-10-11 16:25:36 +00:00
renovate[bot]
08ef53bd7f
chore(deps): update dependency mkdocs-material to v7.3.2 (#1714)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-10-06 21:08:14 +00:00
renovate[bot]
f43d4521a3
chore(deps): update dependency mkdocs-material to v7.3.1 (#1703)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-10-02 13:32:52 +00:00
Renovate Bot
6948de51e1
chore(deps): update dependency mkdocs-material to v7.3.0
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-09-23 09:07:52 +00: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
renovate[bot]
135d80d359
chore(deps): update dependency mkdocs-material to v7.2.8 (#1657)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-09-20 13:02:26 +00:00
renovate[bot]
6a1acd69de
chore(deps): update dependency mkdocs-material to v7.2.7 (#1653)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-09-19 16:24:07 +00: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
renovate[bot]
8517eda620
chore(deps): update dependency mkdocs-material to v7.2.6 (#1606)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-09-01 22:18:35 +00:00
renovate[bot]
01f737aa12
chore(deps): update dependency mkdocs-material to v7.2.5 (#1577)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-08-25 08:56:08 +00:00
renovate[bot]
3de55a6b63
chore(deps): update dependency mkdocs-material to v7.2.4 (#1529)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-08-11 22:21:33 +00: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
renovate[bot]
7ef3e4a1f1
chore(deps): update dependency mkdocs-material to v7.2.3 (#1525)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-08-09 20:56:31 +00:00
Renovate Bot
03b92adc15
chore(deps): update dependency mkdocs-material to v7.2.2
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-08-01 16:13:18 +00:00
Renovate Bot
e89c0d6742
chore(deps): update dependency mkdocs to v1.2.2
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-07-26 19:44:52 +00:00
Renovate Bot
320b1038eb
chore(deps): update dependency mkdocs-material to v7.2.1
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-07-25 13:59:14 +00:00
Renovate Bot
97e7791c72
chore(deps): update dependency mkdocs-material to v7.1.10
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-07-15 18:37:48 +00:00
Renovate Bot
404e7711d8
chore(deps): update dependency mkdocs-material to v7.1.9
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-06-25 10:54:01 +00:00
Renovate Bot
25150cdd04
chore(deps): update dependency mkdocs-material to v7.1.8
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-06-12 12:43:29 +00:00
Renovate Bot
c5f1e238d0
chore(deps): update dependency mkdocs to v1.2.1
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-06-09 17:36:20 +00:00
Renovate Bot
33949aed6c
chore(deps): update dependency mkdocs to v1.2
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-06-07 17:22:10 +00:00
Renovate Bot
cc12d35ddf
chore(deps): update dependency mkdocs-material to v7.1.7
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-06-07 00:18:47 +00:00
Renovate Bot
25851f7a8d
chore(deps): update dependency mkdocs-material to v7.1.6
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-05-31 20:44:54 +00: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
Renovate Bot
0aa27e01b0
chore(deps): update dependency mkdocs-material to v7.1.5
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-05-19 09:14:00 +00: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
Renovate Bot
0e698f6aad
Update dependency pymdown-extensions to v8.2
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-05-08 19:43:43 +00:00
Renovate Bot
ad8a6d0ebc
Update dependency mkdocs-material to v7.1.4
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-05-07 09:51:32 +00:00
Renovate Bot
fc3d98d23a
Update dependency mkdocs-material to v7.1.3
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-04-25 19:19:36 +00: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)
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-04-17 12:42:03 +02:00
Renovate Bot
e93b4f6030
Update dependency mkdocs-material to v7.1.2
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-04-18 22:14:30 +00: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
Renovate Bot
f6a8eb2511
Update dependency mkdocs-material to v7.1.1
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-04-13 19:54:24 +00: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
Renovate Bot
b7b4046dcf
Update dependency mkdocs-material to v7.1.0
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-03-29 21:12:07 +00: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
Renovate Bot
26e9d1c621
Update dependency mkdocs-material to v7.0.7
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-03-28 14:19:41 +00: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
Renovate Bot
10835b53bd
Update dependency mkdocs-material to v7.0.6
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-03-14 14:36:58 +00:00
Renovate Bot
8bbc89bed2
Update dependency mkdocs-material to v7.0.5
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-03-07 19:04:16 +00: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
Renovate Bot
2c7f892069
Update dependency mkdocs-material to v7.0.3
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-02-26 16:08:02 +00:00
Renovate Bot
580f6bbbcf
Update dependency mkdocs-material to v7
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-02-25 19:21:18 +00: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
Renovate Bot
d8f3792bf1
Update dependency mkdocs-material to v6.2.8
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-02-12 22:11:16 +00: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
Renovate Bot
ea5ea73ae1
chore(deps): update dependency mkdocs-material to v6.2.7
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-02-01 21:06:50 +00:00
Renovate Bot
06768e33f5
Update dependency mkdocs-material to v6.2.6
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-01-27 17:23:14 +00:00
Renovate Bot
ce71581661
Update dependency pymdown-extensions to v8.1.1
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-01-26 01:46:17 +00: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
Renovate Bot
6d655b878c
Update dependency mkdocs-material to v6.2.5
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-01-17 10:38:44 +00: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
Renovate Bot
8599965137
Update dependency mkdocs-material to v6.2.4
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-01-10 19:09:49 +00:00
Philip Molares
503639733c
Fix some typos in history.md
(cherry picked from commit 0195d074a8)
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2020-12-01 00:32:48 +01:00
Simon C
3ef987d293
docs: Fix indentation of code 2021-01-08 14:58:01 +01:00
Tilman Vatteroth
7aeaf488c4
Change year in copyright to 2021
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2021-01-06 21:36:07 +01:00
Tilman Vatteroth
7fb7b3cd10
Add license headers
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2021-01-06 14:07:34 +01:00
Tilman Vatteroth
e4080b7ead
Several theme changes (#659)
* Several theme changes

- Add max width of 1440px
- Rename css file
- Fix edit button
- Add local Roboto font

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
(cherry picked from commit 5bdb392413)
2021-01-05 22:55:00 +01:00
Philip Molares
dc63c76f43
added reuse information
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-01-05 22:12:38 +01:00
Tilman Vatteroth
b386737d08
Move docs into subdirectory to make mkdocs work in a subdirectory
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

(cherry picked from commit eaeb88401d)
Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-04 13:07:44 +01:00
David Mehren
80e4d029f7
DB Schema: Make layout pretty
Signed-off-by: David Mehren <git@herrmehren.de>
Co-authored-by: Yannick Bungers <git@innay.de>
2020-10-24 20:55:31 +02:00
David Mehren
990742e569
Note.alias should be optional in db schema
Signed-off-by: David Mehren <git@herrmehren.de>
Co-authored-by: Yannick Bungers <git@innay.de>
2020-10-03 11:14:41 +02:00
David Mehren
566e95f95d
Add note metadata to db schema
Signed-off-by: David Mehren <git@herrmehren.de>
Co-authored-by: Yannick Bungers <git@innay.de>
2020-10-03 11:02:03 +02:00