Commit graph

93 commits

Author SHA1 Message Date
Erik Michelson
45137515a6 fix(docs): title case, community page improvements
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2022-05-18 10:41:27 +02:00
Philip Molares
fbf3100829 docs: consolidate community install methods
Add all community install methods to a single page. This seems to be a better option as all of these methods have very little to document and this makes it easier to browse through the different methods.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2022-05-18 10:41:27 +02:00
Philip Molares
7f170b69a4 docs: add missing links for some files
There were some files which where not included in any links. As this makes them rather unuseful this commit adds them to the appropriate places.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2022-05-18 10:41:17 +02:00
Manu
b4cf434179 Add PikaPods as additional deployment option.
Full name: Manuel Riel

Signed-off-by: Manu <manu@snapdragon.cc>
2022-05-07 20:42:37 +02:00
David Mehren
e222225866 Drop support for Node.js 12
Signed-off-by: David Mehren <git@herrmehren.de>
2022-05-01 21:03:19 +02:00
Sheogorath
3d7bf464d9
docs(manual): Adjust instructions to use only pinned dependencies
This patch adds `--frozen-lockfile` to our regular `yarn install` calls
during manual set up. This should ensure people get the expected
versions and not any newer or older versions that might behave
unexpectedly.

References:
https://github.com/yarnpkg/yarn/issues/5847#issuecomment-537521943
https://classic.yarnpkg.com/en/docs/cli/install#toc-yarn-install-frozen-lockfile

Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2022-04-12 20:16:33 +02:00
David Mehren
836bda0f85
Bump version to 1.9.3
Signed-off-by: David Mehren <git@herrmehren.de>
2022-04-10 21:49:36 +02:00
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
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
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
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
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
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
ProttoyChakraborty
96518a96a3 Updated configuration.md
Signed-off-by: ProttoyChakraborty <pchakraborty2002@gmail.com>
2021-10-01 19:17:04 +05:30
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
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
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
David Mehren
5e771c2f65
Update Content Security Policy docs
Signed-off-by: David Mehren <git@herrmehren.de>
2021-06-07 22:57:12 +02: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
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
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
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
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