github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-25 11:16:31 -05:00
Code Issues Projects Releases Packages Wiki Activity
4125 commits 39 branches 47 tags 112 MiB
Commit graph

118 commits

Author SHA1 Message Date
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
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
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
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
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
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
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
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
David Mehren
b47f1e80b4
Add docs about troubleshooting migrations 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-03-03 12:38:44 +01: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
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
c8a7984fa4
Docs: Various formatting fixes 
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
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
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