mirrors/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2025-05-19 17:55:17 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: run lint:fix

Browse source 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
This commit is contained in:
Philip Molares 2023-07-06 02:45:32 +02:00
parent 366515e760
commit 50d4959e0a
21 changed files with 526 additions and 360 deletions
Download patch file Download diff file Expand all files Collapse all files

21
docs/content/setup/getting_started.md
View file

@ -1,4 +1,6 @@
HedgeDoc 2 currently supports deployment using [Docker Compose](https://docs.docker.com/compose/install/).
# Setup
HedgeDoc 2 currently supports deployment using [Docker Compose][docker-compose].
The `docker` folder in the root of our repo contains all files required to get started, deploying
HedgeDoc 2, a PostgreSQL database and a Caddy reverse proxy.
@ -6,8 +8,8 @@ HedgeDoc 2, a PostgreSQL database and a Caddy reverse proxy.
## Development or local testing
To run HedgeDoc 2 locally, you do not need to change anything.
Caddy will automatically generate a TLS certificate for `hedgedoc2.localhost` using its internal CA.
After running `docker compose up`, visit [https://hedgedoc2.localhost](https://hedgedoc2.localhost).
Caddy will automatically generate a TLS certificate for `hedgedoc2.localhost` using its internal CA.
After running `docker compose up`, visit <https://hedgedoc2.localhost>.
You will have to accept the TLS warning in your browser the first time the page is opened.
## Production setup
@ -15,7 +17,7 @@ You will have to accept the TLS warning in your browser the first time the page
!!! danger "HedgeDoc 2 is not yet production ready!"
This section explains how a production deployment of HedgeDoc 2 on a publicly accessible domain
might look in the future.
HedgeDoc 2 itself is not production ready yet, so only use these instructions to set up an
HedgeDoc 2 itself is not production ready yet, so only use these instructions to set up an
instance for testing with your friends.
For a production setup, first set a unique session secret with
@ -23,13 +25,16 @@ For a production setup, first set a unique session secret with
Then open the `.env` file and edit `HD_BASE_URL`. It needs to contain the full URL of your instance,
like it will be entered in the browser. If you enter a URL starting with `https://`, Caddy will
automatically gather certificates via *Let's Encrypt* (or its internal CA in case of `.localhost` domains).
automatically gather certificates via *Let's Encrypt*
(or its internal CA in case of `.localhost` domains).
Make sure your host is accessible under the domain from `HD_BASE_URL`, otherwise Let's Encrypt
validation will fail.
Optionally, you can also change
- `HD_MEDIA_BACKEND`: If you do not want HedgeDoc to handle media uploads itself, configure another backend
here. For more information, [see the media backend docs](/config/#media).
- `HD_MEDIA_BACKEND`: If you do not want HedgeDoc to handle media uploads itself, configure
another backend here. For more information, [see the media backend docs](/config/#media).
- `HD_AUTH_*`: If you do not want to use the integrated auth system,
you can [consult the authentication docs](/config/#authentication) for details.
[docker-compose]: https://docs.docker.com/compose/install/