Commit graph

458 commits

Author SHA1 Message Date
David Mehren
d88dd31cc2 docs: add example for generating sessionSecret
Signed-off-by: David Mehren <git@herrmehren.de>
2022-04-03 20:41:08 +02:00
Renovate Bot
a61483a613 chore(deps): update dependency mkdocs-material to v8.2.8
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-03-27 17:05:50 +00:00
Renovate Bot
7eb609a06e chore(deps): update dependency mkdocs to v1.3.0
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-03-26 22:43:38 +01:00
Renovate Bot
875150e1e9 chore(deps): update dependency mkdocs-material to v8.2.7
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-03-26 08:48:45 +00:00
Moritz Schlarb
e6fc9f01a3 Allow SAML authentication provider to be named
Using `CMD_SAML_PROVIDERNAME` and the respective auth provider objects
in the configuration structures.

Signed-off-by: Moritz Schlarb <schlarbm@uni-mainz.de>
2022-03-20 19:59:53 +01:00
Renovate Bot
002c7897d8 chore(deps): update dependency pymdown-extensions to v9.3
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-03-20 19:55:07 +01:00
Renovate Bot
6bb9720a81 chore(deps): update dependency mkdocs-material to v8.2.5
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-03-06 17:30:04 +01:00
Renovate Bot
bdc55f2139 chore(deps): update dependency mkdocs-material to v8.2.4
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-03-05 02:53:28 +00:00
Renovate Bot
b32c4c73e0 chore(deps): update dependency mkdocs-material to v8.2.3
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-02-27 18:22:26 +01:00
Renovate Bot
e26648fb54 chore(deps): update dependency mkdocs-material to v8.2.2
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-02-26 11:12:53 +00:00
Renovate Bot
f4e8bef013 chore(deps): update dependency mkdocs-material to v8.2.1
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-02-19 20:36:23 +01:00
Erik Michelson
bbb61036c8 Use localhost instead of 127.0.0.1 in docker guide
The example docker-compose.yml in the docker guide sets CMD_DOMAIN to
localhost. This results in HedgeDoc only being startable from
http://localhost:3000 as the Content-Security-Policy forbids access
to e.g. http://127.0.0.1:3000. Despite that the docs used 127.0.0.1
for linking to the instance prior to this commit.

Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2022-02-14 15:38:33 +01:00
Renovate Bot
26b2e8d2d5 chore(deps): update dependency pymdown-extensions to v9.2
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-02-12 11:55:55 +01:00
Renovate Bot
4d80acd412 chore(deps): update dependency mkdocs-material to v8.1.11
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-02-12 03:51:11 +00:00
Renovate Bot
c8a74df72c chore(deps): update dependency mkdocs-material to v8.1.10
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-02-06 12:13:48 +00:00
Renovate Bot
7e8767de2a chore(deps): update dependency mkdocs-material to v8.1.9
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-01-30 11:19:16 +00:00
Dennis Gaida
7c912b17ec Working example & documentation for Authelia
Signed-off-by: Dennis Gaida <2392217+DennisGaida@users.noreply.github.com>
2022-01-29 17:16:05 +01:00
Renovate Bot
948978301c
chore(deps): update dependency mkdocs-material to v8.1.8
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2022-01-23 19:08:52 +00:00
renovate[bot]
35b6756327
chore(deps): update dependency mkdocs-material to v8.1.7 (#1981)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2022-01-16 18:14:17 +00:00
renovate[bot]
01ee271cf7
chore(deps): update dependency mkdocs-material to v8.1.6 (#1969)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2022-01-15 02:22:57 +00:00
renovate[bot]
a79e9d6bae
chore(deps): update dependency mkdocs-material to v8.1.5 (#1963)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2022-01-09 15:44:44 +00:00
renovate[bot]
2de73a80cd
chore(deps): update dependency mkdocs-material to v8.1.4 (#1947)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2022-01-02 14:05:42 +00:00
renovate[bot]
a673bd7605
chore(deps): update dependency mkdocs-material to v8.1.3 (#1921)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-12-19 15:08:31 +00:00
renovate[bot]
69c9fe6e76
chore(deps): update dependency mkdocs-material to v8.1.2 (#1907)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-12-18 05:31:46 +00:00
Renovate Bot
b47081a230
chore(deps): update dependency mkdocs-material to v8.1.0
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-12-11 05:01:34 +00:00
renovate[bot]
90bb535e7d
chore(deps): update dependency mkdocs-material to v8.0.5 (#1888)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-12-11 04:59:32 +00:00
Sandro
c52958dec1
docs/reverse-proxy: align NC
Signed-off-by: Sandro Jäckel <sandro.jaeckel@gmail.com>
2021-12-08 00:08:22 +01:00
Renovate Bot
326e6cad26
chore(deps): update dependency mkdocs-material to v8
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-12-04 13:02:13 +00:00
David Mehren
1a0e6e8ae8
Bump version to 1.9.2
Signed-off-by: David Mehren <git@herrmehren.de>
2021-12-03 20:33:53 +01:00
David Mehren
ece1bb8d56
Update Node requirements in manual setup guide
Signed-off-by: David Mehren <git@herrmehren.de>
2021-12-02 22:32:32 +01:00
Tilman Vatteroth
3d05aac2d5
Bump version to 1.9.1
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
Signed-off-by: David Mehren <git@herrmehren.de>
2021-12-02 22:14:54 +01:00
Danilo Bargen
74d7fc06f3 Docs: Document UPLOADS_MODE env var for Docker image
Signed-off-by: Danilo Bargen <mail@dbrgn.ch>
2021-11-24 22:51:06 +01:00
Tilman Vatteroth
661d387cfe
Add new FAQ section "Why does my interface look weird?"
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2021-11-21 22:11:43 +01:00
Renovate Bot
f048565eea
chore(deps): update dependency pymdown-extensions to v9
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-11-20 02:12:19 +00:00
renovate[bot]
25a9be8c6e
chore(deps): update dependency mkdocs-material to v7.3.6 (#1791)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-10-30 14:07:22 +00:00
renovate[bot]
03dc863f7f
chore(deps): update dependency mkdocs-material to v7.3.5 (#1785)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

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

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-10-19 04:03:58 +00:00
renovate[bot]
f02d70b491
chore(deps): update dependency mkdocs to v1.2.3 (#1730)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-10-13 18:34:08 +00:00
renovate[bot]
c8907d09d9
chore(deps): update dependency mkdocs-material to v7.3.3 (#1726)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

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

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-10-06 21:05:06 +00:00
David Mehren
30c88d16b1
Merge pull request #1700 from ProttoyChakraborty/master 2021-10-06 18:53:08 +02:00
renovate[bot]
32f7813a84
chore(deps): update dependency mkdocs-material to v7.3.1 (#1702)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-10-02 13:30:39 +00:00
ProttoyChakraborty
96518a96a3 Updated configuration.md
Signed-off-by: ProttoyChakraborty <pchakraborty2002@gmail.com>
2021-10-01 19:17:04 +05:30
Renovate Bot
c63320a578
chore(deps): update dependency mkdocs-material to v7.3.0
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-09-23 09:07:24 +00:00
renovate[bot]
adfe820c98
chore(deps): update dependency mkdocs-material to v7.2.8 (#1656)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

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

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-09-19 16:22:14 +00:00
David Mehren
c3deb715dd
Bump version to 1.9.0
Signed-off-by: David Mehren <git@herrmehren.de>
2021-09-13 21:57:57 +02:00
Yannick Bungers
0a29738e62
Merge pull request #1610 from hedgedoc/fix-hfm-header
Fix usage of "HFM" in table headers
2021-09-03 12:34:46 +02:00
Tilman Vatteroth
4f76585664
Fix usage of "HFM" in table headers
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2021-09-02 22:00:16 +02:00
renovate[bot]
04c4dd888f
chore(deps): update dependency mkdocs-material to v7.2.6 (#1605)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-09-01 22:16:08 +00:00
David Mehren
ca71473ed9
Bump version to 1.9.0-rc1
Signed-off-by: David Mehren <git@herrmehren.de>
2021-08-29 17:55:19 +02:00
Yannick Bungers
74b10d4e9b
Merge pull request #1571 from hedgedoc/chore/remove_tedious
Drop support for MS SQL Server
2021-08-26 19:59:56 +02:00
renovate[bot]
2fb83e5a34
chore(deps): update dependency mkdocs-material to v7.2.5 (#1576)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-08-25 08:54:44 +00:00
David Mehren
7729cc49a7
Drop support for MS SQL Server
Sequelize generates invalid SQL for the 'fix-enum' migration from 2018.
Since nobody has complained about this issue since then, we can just
drop support for SQL Server.

Signed-off-by: David Mehren <git@herrmehren.de>
2021-08-23 17:45:45 +02:00
David Mehren
e0b5c63f93
Merge pull request #1532 from hedgedoc/docs/faq 2021-08-19 21:31:10 +02:00
David Mehren
c7d581953c
Add heading to FAQ
Signed-off-by: David Mehren <git@herrmehren.de>
2021-08-19 20:22:17 +02:00
David Mehren
957d7d553e
Merge pull request #1394 from hedgedoc/remove-cdn 2021-08-15 20:11:26 +02:00
David Mehren
31bfd6d779
Clarify csp.allowFraming docs
Signed-off-by: David Mehren <git@herrmehren.de>
2021-08-15 00:22:31 +02:00
David Mehren
2ac89d3334
Use consistent wording in CSP docs
Signed-off-by: David Mehren <git@herrmehren.de>
2021-08-15 00:22:31 +02:00
David Mehren
6c722f0ad6
Add config option to disallow embedding PDFs
Signed-off-by: David Mehren <git@herrmehren.de>
2021-08-15 00:22:31 +02:00
David Mehren
bd44cbc16c
Add config option to disallow framing via CSP
Signed-off-by: David Mehren <git@herrmehren.de>
2021-08-15 00:22:30 +02:00
Tilman Vatteroth
9498ee6bfe
Remove cdn support
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2021-08-15 00:09:53 +02:00
David Mehren
daf7d61ea2
Link to config docs in embedding FAQ
Signed-off-by: David Mehren <git@herrmehren.de>
2021-08-14 23:48:17 +02:00
David Mehren
c1976425da
Use consistent spelling in FAQs
Signed-off-by: David Mehren <git@herrmehren.de>
2021-08-14 23:48:17 +02:00
David Mehren
ccced2d92c
Change homepage link to new FAQs
Signed-off-by: David Mehren <git@herrmehren.de>
2021-08-14 23:48:17 +02:00
David Mehren
eb270fdb6b
Add FAQ entry about broken migrations
Signed-off-by: David Mehren <git@herrmehren.de>
2021-08-14 23:48:17 +02:00
David Mehren
6d0187bead
Add FAQ entry about broken image upload
Signed-off-by: David Mehren <git@herrmehren.de>
2021-08-14 23:48:17 +02:00
David Mehren
c9388add9d
Add FAQ entry about iframing HedgeDoc
Signed-off-by: David Mehren <git@herrmehren.de>
2021-08-14 23:48:17 +02:00
David Mehren
038c1b4868
Port over the FAQ page from hedgedoc.org
Signed-off-by: David Mehren <git@herrmehren.de>
2021-08-14 23:48:17 +02:00
David Mehren
cc76201cfb
Merge pull request #1533 from hedgedoc/feature/database-env
feat(config): Improve configurability of database by env
2021-08-14 23:41:58 +02:00
David Mehren
9650950d00
Docs: Use Postgres 13 in Docker example
After https://github.com/hedgedoc/container/pull/181 has been merged,
we should now also use PG 13 in the example snippet.

Signed-off-by: David Mehren <git@herrmehren.de>
2021-08-14 17:15:40 +02:00
Philip Molares
e158839f46 docs: fix typos
Fixed some typos geeked pointed out on the forum

See https://community.hedgedoc.org/t/couple-spelling-errors-on-your-docs-home-page/453

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-08-14 00:28:09 +02:00
Sheogorath
1428a8e006
feat(config): Improve configurability of database by env
This patch implements 6 additional environment variables that are used
for configuration of the database in order to allow easier configuration
in containerised environments, such as Kubernetes.

An example is the upcoming deployment of the demo instance that will use
an operator-backed postgresql database. This operator exposes username
and password as separate variables and while it's obviously possible to
generate a dbURL from that, this won't be possible without additional
code. Aiming for a solution in Hedgedoc itself, will help us to enable
other people in using Hedgedoc on Kubernetes without resulting in overly
customised setups for simple tasks like this.

Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2021-08-13 01:58:53 +02:00
renovate[bot]
6c17823da1
chore(deps): update dependency mkdocs-material to v7.2.4 (#1528)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-08-11 22:19:17 +00:00
renovate[bot]
d0244affdf
chore(deps): update dependency mkdocs-material to v7.2.3 (#1524)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-08-09 20:53:48 +00:00
renovate[bot]
4ca2600a27
chore(deps): update dependency mkdocs-material to v7.2.2 (#1489)
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
2021-08-01 16:10:22 +00:00
Renovate Bot
32f0f90a7e
chore(deps): update dependency mkdocs to v1.2.2
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-07-26 19:41:59 +00:00
Renovate Bot
70801917bf
chore(deps): update dependency mkdocs-material to v7.2.1
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-07-26 18:19:05 +00:00
David Mehren
0f566c5ce7
[Docs] Add Mattermost guide to navigation
Signed-off-by: David Mehren <git@herrmehren.de>
2021-07-18 10:02:17 +02:00
Renovate Bot
ac65de1348
chore(deps): update dependency mkdocs-material to v7.1.10
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-07-10 14:44:41 +00:00
Renovate Bot
f0110eae23
chore(deps): update dependency mkdocs-material to v7.1.9
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-06-25 10:53:38 +00:00
Renovate Bot
2125e9b98d
chore(deps): update dependency mkdocs-material to v7.1.8
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-06-12 14:17:30 +00:00
Renovate Bot
7dd0efa688
chore(deps): update dependency mkdocs to v1.2.1
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-06-09 17:35:54 +00:00
Renovate Bot
0a7d0a74fa
chore(deps): update dependency mkdocs to v1.2
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-06-08 20:35:36 +00:00
David Mehren
5e771c2f65
Update Content Security Policy docs
Signed-off-by: David Mehren <git@herrmehren.de>
2021-06-07 22:57:12 +02:00
Renovate Bot
a3581c514b
chore(deps): update dependency mkdocs-material to v7.1.7
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-06-07 00:17:03 +00:00
Erik Michelson
df7a5e3f6c
Fix link in openapi doc
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2021-06-06 20:33:25 +02:00
Tilman Vatteroth
9a6d5d675a
Remove explicit title from cloudflare warning
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2021-06-03 23:24:09 +02:00
Yannick Bungers
23fa44cd36
Merge pull request #1346 from hedgedoc/add-cloudflare-warning-to-docs
Add Cloudflare warning to the docs
2021-06-03 20:43:46 +02:00
Tilman Vatteroth
ff12e3b23e
Add Cloudflare warning to the docs
The cloudflare minify feature for HTML, CSS and JS breaks HedgeDoc.

Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2021-06-03 17:30:07 +02:00
Renovate Bot
4f592d32e2
chore(deps): update dependency mkdocs-material to v7.1.6
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-05-31 19:17:51 +00:00
Renovate Bot
b072da418d
chore(deps): update dependency mkdocs-material to v7.1.5
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-05-19 09:13:36 +00:00
David Mehren
32e31ac1e3
Bump version to 1.8.2
Signed-off-by: David Mehren <git@herrmehren.de>
2021-05-11 21:28:10 +02:00
Renovate Bot
1d5cd3cdc9
Update dependency pymdown-extensions to v8.2
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-05-08 17:26:14 +00:00
Philip Molares
a4b4ebd80c Docs: Add mention to install devDependencies
Before `yarn build` can be succesfully run, we need to install the devDependencies.
This is necessary, because `bin/setup` does not install the devDependencies…

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-05-08 13:47:31 +02:00
David Mehren
0555d01f4a
Bump version to 1.8.1
Signed-off-by: David Mehren <git@herrmehren.de>
2021-05-06 22:24:02 +02:00
Renovate Bot
0ec7daf5f7
Update dependency mkdocs-material to v7.1.4
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-05-06 19:09:54 +00:00
David Mehren
e6d4ac5f9a
Remove mention of .sequelizerc from docs
Signed-off-by: David Mehren <git@herrmehren.de>
2021-05-03 22:26:08 +02:00
David Mehren
73e26e1d2d
Bump version to 1.8.0
Signed-off-by: David Mehren <git@herrmehren.de>
2021-05-03 22:26:08 +02:00
David Mehren
6cccc558e6
Bump version to 1.8.0-rc1
Signed-off-by: David Mehren <git@herrmehren.de>
2021-04-26 21:42:03 +02:00
Renovate Bot
7d21e12d05
Update dependency mkdocs-material to v7.1.3
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-04-25 18:35:34 +00:00
David Mehren
2faf5b6974
Merge pull request #1150 from hedgedoc/feature/prometheus_metrics 2021-04-25 20:34:03 +02:00
David Mehren
cbe7b03b59
Document new Prometheus endpoint
Signed-off-by: David Mehren <git@herrmehren.de>
2021-04-25 20:06:56 +02:00
David Mehren
e1df30bd5c
Raise minimum required Node.js version to 12
As Node 10 will be EOL at April 30th, we should stop supporting
and/or promoting the usage of that version.

See also https://endoflife.date/nodejs

Signed-off-by: David Mehren <git@herrmehren.de>
2021-04-22 22:52:38 +02:00
Renovate Bot
f697d6699a
Update dependency mkdocs-material to v7.1.2
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-04-22 15:14:44 +00:00
Philip Molares
7192ec63f3 Docs: Revert changes to manual setup
This reverts the documentation changes of bf0a7ebee7. This is necessary as the omitted remarks about `.sequlizerc` can't be omitted until 1.8 is released.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-04-22 13:31:12 +02:00
David Mehren
a15124ba35
Merge pull request #1145 from hedgedoc/docs/darkTheme
Documentation: Add toggleable dark theme
2021-04-18 22:50:50 +02:00
Philip Molares
60251d89ee
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>
2021-04-18 22:44:02 +02:00
Yannick Bungers
58f5282ccb
Merge pull request #984 from hedgedoc/docs/upgrade-instructions 2021-04-17 16:33:49 +02:00
David Mehren
e8465aa8be
Docs: Fixup some wording in manual setup guide
Signed-off-by: David Mehren <git@herrmehren.de>
2021-04-16 21:19:13 +02:00
David Mehren
c7104c94e4
Docs: Add hint about account creation
Signed-off-by: David Mehren <git@herrmehren.de>
2021-04-16 21:19:13 +02:00
David Mehren
70a289aeba
Docs: Include minimal config on manual setup page
To make it easier to get started, this commit adds a minimal
`config.json` snipped to the manual setup instruction.

Signed-off-by: David Mehren <git@herrmehren.de>
2021-04-16 21:19:13 +02:00
David Mehren
87e0cea2f9
Docs: Cleanup docker page
Build instructions are not relevant for most users.

Contact info can already be found on the 'Home' page.

Signed-off-by: David Mehren <git@herrmehren.de>
2021-04-16 21:19:13 +02:00
David Mehren
a3ee2c6f8c
Docs: Move migration hints to getting started page
These are relevant for all installation methods, so they should be
placed at a 'global' place.

Signed-off-by: David Mehren <git@herrmehren.de>
2021-04-16 21:19:13 +02:00
David Mehren
2667b642f4
Docs: Include docker-compose snippet
Directing users to use the container repo to install
HedgeDoc has caused upgrade-trouble in the past, after we made
incompatible changes to the docker-compose.yml in the repo.

This commit inserts a minimal docker-compose snipped in the
docs, which can be used to get started. Upgrading can then
be performed by just incrementing the referenced image version.

Signed-off-by: David Mehren <git@herrmehren.de>
2021-04-16 21:19:11 +02:00
David Mehren
c54eef10a6
Add an example systemd unit to installation docs
Heavily inspired by the unit of Arch Linux:
https://github.com/archlinux/svntogit-community/blob/packages/hedgedoc/trunk/hedgedoc.service

Fixes https://github.com/hedgedoc/hedgedoc/issues/46

Signed-off-by: David Mehren <git@herrmehren.de>
2021-04-16 21:18:35 +02:00
David Mehren
27d53f5233
Remove ancient migration docs
Signed-off-by: David Mehren <git@herrmehren.de>
2021-04-16 21:18:35 +02:00
David Mehren
3eb049e24b
Migrate container docs to main documentation
Signed-off-by: David Mehren <git@herrmehren.de>
2021-04-16 21:18:33 +02:00
David Mehren
1f4388802b
Docs: Improve manual installation guide
- Move the requirements into an info block
- Make clear that we use Yarn Classic
- Link to our downloads page instead of GitHub
- Simplify paragraph about configuring HedgeDoc
- Move additional information into `<small>` tags
- Match upgrade documentation to installation steps.

Signed-off-by: David Mehren <git@herrmehren.de>
2021-04-15 21:52:58 +02:00
David Mehren
24dbc23ab0
Docs: Add a note about upgrading to the getting started guide
Signed-off-by: David Mehren <git@herrmehren.de>
2021-04-13 21:46:40 +02:00
Renovate Bot
8ad7108f6c
Update dependency mkdocs-material to v7.1.1
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-04-10 10:35:06 +00:00
Erik Michelson
185c50b25f
Replace codimd.org link with hedgedoc.org
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2021-04-08 21:43:48 +02:00
Yannick Bungers
572affdfb6
Merge pull request #1101 from hedgedoc/add-missing-mkdocs-plugin 2021-04-04 22:09:35 +02:00
Tilman Vatteroth
5218a4f07f
Fix emoji replacement in SAML docs
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2021-04-04 16:30:46 +02:00
Tilman Vatteroth
53e3a816b1
Add missing footnote mkdocs extension
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2021-04-03 21:15:18 +02:00
Tilman Vatteroth
4a0b00d0a6
Replace Unicode character with emoji shortcode
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2021-04-03 21:14:53 +02:00
Tilman Vatteroth
f355cfc864
[Docs] Add "HedgeDoc flavored markdown" page
Co-authored-by: Philip Molares <philip.molares@udo.edu>
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2021-04-01 08:45:29 +02:00
Renovate Bot
53c83003ee
Update dependency mkdocs-material to v7.1.0
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-03-29 21:04:12 +00:00
Renovate Bot
48568d8ef4
Update dependency mkdocs-material to v7.0.7
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-03-28 14:19:17 +00:00
Renovate Bot
01bcfc499b
Update dependency mkdocs-material to v7.0.6
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-03-14 14:36:35 +00:00
Renovate Bot
7a6d9752bd
Update dependency mkdocs-material to v7.0.5
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-03-07 19:03:55 +00:00
David Mehren
bf0a7ebee7
Remove .sequelizerc
After https://github.com/hedgedoc/hedgedoc/pull/969 was merged,
a separate configuration file for the sequelize-cli is no longer
required.

Signed-off-by: David Mehren <git@herrmehren.de>
2021-03-06 10:34:22 +01:00
Renovate Bot
b70ce530ca
Update dependency mkdocs-material to v7.0.4
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-03-04 19:35:19 +00:00
David Mehren
b47f1e80b4
Add docs about troubleshooting migrations
Signed-off-by: David Mehren <git@herrmehren.de>
2021-03-03 12:38:44 +01:00
Renovate Bot
6798ee9056
Update dependency mkdocs-material to v7.0.3
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-02-26 16:07:38 +00:00
Renovate Bot
c97530fcf0
Update dependency mkdocs-material to v7
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-02-25 19:10:35 +00:00
Tilman Vatteroth
ed9e74e68b
Fix link to sequelize database dialect docs
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2021-02-09 13:18:54 +01:00
Renovate Bot
4af6a8d302
chore(deps): update dependency pymdown-extensions to v8.1.1
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-02-05 11:46:59 +00:00
Renovate Bot
6972f19e79
chore(deps): update dependency mkdocs-material to v6.2.8
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-02-04 20:47:49 +00:00
Tilman Vatteroth
63b50651df
[Docs] Add "getting started" page
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2021-02-03 21:42:49 +01:00
Tilman Vatteroth
dc76d158e7
[Docs] Extend setup page with community methods
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2021-02-03 20:54:29 +01:00
Nicolas Dietrich
5e269e4af9 Keep JS and env varibale name in sync (requireFreeURLAuthentication)
Signed-off-by: Nicolas Dietrich <nidi@mailbox.org>
2021-01-23 14:14:47 +01:00
Nicolas Dietrich
497569fee4 Add config option which requires authentication in FreeURL mode
This mitigates unintended note creation by bots or humans through a
simple GET call.

See discussion in #754.

Signed-off-by: Nicolas Dietrich <nidi@mailbox.org>
2021-01-22 16:52:49 +01:00
Tilman Vatteroth
4d48ef1509
[Documentation] Fix link in manual setup
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2021-01-21 21:22:07 +01:00
Tilman Vatteroth
46eda5eead
Rewrite sentence
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2021-01-18 16:56:32 +01:00
Tilman Vatteroth
c1d9364a1a
Add page to setup namespace
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2021-01-18 16:51:03 +01:00
David Mehren
e9d4587344
Bump version to 1.7.2
Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-15 20:37:30 +01:00
David Mehren
eaa7a15615
Docs: Reorder navigation links
Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-13 20:59:32 +01:00
David Mehren
c8a7984fa4
Docs: Various formatting fixes
Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-13 20:59:32 +01:00
David Mehren
1256eb3cd3
Docs: Use extensions to make markdown parsing more like GFM
Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-13 20:59:32 +01:00
David Mehren
512fc2a914
GitLab Auth Guide: Fix indentation
Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-11 12:05:31 +01:00
David Mehren
bf7d4ddcd8
GitHub Auth Guide: Fix indentation
Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-11 12:04:56 +01:00
David Mehren
ee83c85eb0
SAML Auth Guide: Fix indentation
Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-11 12:03:48 +01:00
David Mehren
80d8cc79f6
Docs: Unify code block languages
Use `yaml` for Dockerfiles, `shell` for environment variables and `json` for our config file.

Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-11 12:00:33 +01:00
David Mehren
877bc26078
Docs: Replace :smile with actual 😃 emoji
Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-11 11:54:33 +01:00
David Mehren
1d92a81755
Docs: Enable SuperFences extension
This allows indented code blocks in lists

Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-11 11:54:33 +01:00
Simon C
6dab69de60
docs: Fix indentation of code
(cherry picked from commit 4559d52d52)
Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-11 11:12:57 +01:00
Tilman Vatteroth
5bdb392413
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>
2021-01-05 22:55:00 +01:00
Tilman Vatteroth
eaeb88401d
Move docs into subdirectory to make mkdocs work in a subdirectory
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2021-01-05 13:15:32 +01:00
David Mehren
fdc86538c6
Merge pull request #650 from hedgedoc/mkdocs 2021-01-04 18:35:08 +01:00
Philip Molares
90371c1c00 added documentation about how the write, build and deploy this
documentation.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-01-04 14:26:39 +01:00
David Mehren
9f191bd58f
Merge pull request #646 from hedgedoc/kubernetes 2021-01-04 13:35:24 +01:00
Philip Molares
0911bf96e9 added all necessary configs to use structor
see https://github.com/traefik/structor

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-01-03 22:15:12 +01:00
Philip Molares
dfa12e52e6 remove old documentation
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-01-03 16:10:27 +01:00
Philip Molares
55d653a1a2 started work on a mkdocs documentation for readthedocs.org
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-01-03 16:00:25 +01:00
Philip Molares
d462675fc8 Update docs/setup/kubernetes.md
Co-authored-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-01-02 16:14:22 +01:00
Philip Molares
d7ef5e83c2 changed kubernetes setup doc
currently we don't provide our own and still linking to hackmd/codimd is
not helpful

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-01-02 11:01:34 +01:00
David Mehren
7d2c433b1b
Bump version to 1.7.1
Signed-off-by: David Mehren <git@herrmehren.de>
2020-12-27 20:54:39 +01:00
aptalca
b9c043bf6b update linuxserver docker info
Update badges and info to point to the newly published HedgeDoc image

Signed-off-by: aptalca <aptalca@linuxserver.io>
2020-12-24 17:00:31 -05:00
Philip Molares
a41d9e4c11 Update configuration.md
Added a more in depth example of how to set CMD_DB_URL or dbUrl

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2020-12-22 20:32:27 +01:00
ericgaspar
8dc215fd98
Set Install-with-yunohost bagde to SVG
Signed-off-by: ericgaspar <junk.eg@free.fr>
2020-12-21 23:28:56 +01:00
David Mehren
faf3010c39
Bump version to 1.7.0
Signed-off-by: David Mehren <git@herrmehren.de>
2020-12-21 21:36:40 +01:00
David Mehren
22d2bf00fc
Fix typo in reverse proxy docs
Signed-off-by: David Mehren <git@herrmehren.de>
2020-12-13 19:09:41 +01:00
David Mehren
2f5ca84605
Document reverse proxy config for Apache
As we found out in #616, Apache does not set the `X-Forwarded-Proto` header, which is now required because we switched to secure cookies in 383d791a50.

Signed-off-by: David Mehren <git@herrmehren.de>
2020-12-13 19:09:34 +01:00
David Mehren
2338a98731
Merge pull request #613 from nidico/patch-1
Fix some typos in history.md
2020-12-03 22:18:50 +01:00
David Mehren
81e463250d
Release 1.7.0-rc2
Signed-off-by: David Mehren <git@herrmehren.de>
2020-12-02 23:15:56 +01:00
Nicolas Dietrich
0195d074a8
Fix some typos in history.md 2020-12-01 00:32:48 +01:00
ericgaspar
d1a0ca05af
Update yunohost.md
Signed-off-by: ericgaspar <junk.eg@free.fr>

Upgrade YunoHost doc link

Signed-off-by: ericgaspar <junk.eg@free.fr>
2020-11-30 14:16:10 +01:00
David Mehren
9caaaf48e3
Bump Version to 1.7.0-rc1
Signed-off-by: David Mehren <git@herrmehren.de>
2020-11-29 15:59:23 +01:00
David Mehren
a5d835cb74
Merge pull request #597 from hedgedoc/fix/install-docs 2020-11-29 15:51:43 +01:00
David Mehren
c83c6cb226
Document that Git can also be used to checkout releases.
Signed-off-by: David Mehren <git@herrmehren.de>
2020-11-27 22:41:54 +01:00
David Mehren
7bcf548cd2
Mention that the database connection string needs an absolute path to the SQLite file
Signed-off-by: David Mehren <git@herrmehren.de>
2020-11-27 22:41:54 +01:00
David Mehren
b78a58c0a9
Update manual install docs for 1.7
Starting with 1.7, releases include the frontend bundle.
This commit updates the docs accordingly.

Signed-off-by: David Mehren <git@herrmehren.de>
2020-11-27 22:41:54 +01:00
David Mehren
61f54db63e
Merge pull request #596 from hedgedoc/remove-pdf-export-code
Remove pdf export code
2020-11-27 18:31:19 +01:00
Yannick Bungers
8f7e11f780
Merge pull request #595 from joachimmathes/oauth2_authorization
Add oauth2 authorization roles
2020-11-27 09:09:29 +01:00
Tilman Vatteroth
97312b5ed3
Remove pdf export code
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2020-11-26 21:09:23 +01:00
Joachim Mathes
729b387536 Add oauth2 authorization
Signed-off-by: Joachim Mathes <joachim_mathes@web.de>
2020-11-25 19:23:55 +01:00
Nils VAN ZUIJLEN
3449a85e4d
Replace nGinx by Nginx
Signed-off-by: Nils VAN ZUIJLEN <nils.van-zuijlen@mailo.com>
2020-11-18 18:39:31 +01:00
Nils VAN ZUIJLEN
379cff97d9
Add documentation for reverse-proxy use
Fixes #256

Signed-off-by: Nils VAN ZUIJLEN <nils.van-zuijlen@mailo.com>
2020-11-18 16:29:18 +01:00
Erik Michelson
938d39495f
Updated screenshot
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2020-11-17 11:13:58 +01:00
Tilman Vatteroth
9898ab3ca5
Rename image file 2020-11-15 20:37:56 +01:00
Tilman Vatteroth
f37d890c65
Replace hedgedoc logo with horizontal 2020-11-15 20:37:01 +01:00
Tilman Vatteroth
243046e620
Rename image 2020-11-15 20:35:05 +01:00
Tilman Vatteroth
ad15c607db
Resize hedgedoc logo for readme 2020-11-15 20:33:15 +01:00
Tilman Vatteroth
b600f7fb4a
Resize readme image 2020-11-15 20:30:46 +01:00
Tilman Vatteroth
762376b925
Replace image in readme 2020-11-15 20:29:44 +01:00
Tilman Vatteroth
4688eec853
change images in docs auth github 2020-11-15 20:24:05 +01:00
mrdrogdrog
d10c13e842
Update docs/configuration.md
Co-authored-by: Erik Michelson <github@erik.michelson.eu>
2020-11-15 20:03:09 +01:00
mrdrogdrog
2e3d915927
Update docs/setup/docker.md
Co-authored-by: Philip Molares <git@molar.es>
2020-11-15 13:19:59 +01:00
mrdrogdrog
5aeec761e2
Update docs/setup/docker.md
Co-authored-by: Philip Molares <git@molar.es>
2020-11-15 13:19:50 +01:00