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

Add new FAQ section "Why does my interface look weird?"

Browse source 
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
This commit is contained in:
Tilman Vatteroth 2021-11-18 16:57:02 +01:00
parent de3b49a451
commit 661d387cfe
No known key found for this signature in database
GPG key ID: B97799103358209B
4 changed files with 37 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

19
docs/content/guides/reverse-proxy.md
View file

@ -12,7 +12,7 @@ This documentation will cover HTTPS setup, with comments for HTTP setup.
## HedgeDoc config
[Full explanation of the configuration options](../configuration.md)
### Useful configuration options
| `config.json` parameter | Environment variable | Value | Example |
|-------------------------|----------------------|-------|---------|
@ -25,6 +25,23 @@ This documentation will cover HTTPS setup, with comments for HTTP setup.
| `urlAddPort` | `CMD_URL_ADDPORT` | `false`, HedgeDoc should not append its port to the URLs it links | `false` |
| `hsts.enable` | `CMD_HSTS_ENABLE` | `true` if you host over SSL, `false` otherwise | `true` |
[Full explanation of the configuration options](../configuration.md)
### Configure asset link generation
HedgeDoc generates links to other pages and to assets (like images, stylesheets, fonts, etc) using the following settings. You must configure them according to the URL that you use to access your instance.
- `domain` (env: `CMD_DOMAIN`)
- `protocolUseSSL` (env: `CMD_PROTOCOL_USESSL`)
- `urlAddPort` (env: `CMD_URL_ADDPORT`)
!!! example
You access your HedgeDoc instance using a reverse proxy via `https://markdown.example`. You must set:
- `domain` to `markdown.example`.
- `protocolUseSSL` to `true` because you access your instance via HTTPS.
- `urlAddPort` to `false` because you access the instance using the default HTTPS port.
## Reverse Proxy config