mirror of
https://github.com/hedgedoc/hedgedoc.git
synced 2025-05-16 08:04:45 -04:00
docs: restructure documentation
This rewrite follows the principles of https://diataxis.fr/ Co-authored-by: Erik Michelson <github@erik.michelson.eu> Signed-off-by: Philip Molares <philip.molares@udo.edu> Signed-off-by: Erik Michelson <github@erik.michelson.eu>
This commit is contained in:
parent
e0dd24ed29
commit
e07cd62596
68 changed files with 1163 additions and 315 deletions
14
docs/content/files/setup-docker/Caddyfile
Normal file
14
docs/content/files/setup-docker/Caddyfile
Normal file
|
@ -0,0 +1,14 @@
|
|||
{$HD_BASE_URL}
|
||||
|
||||
log {
|
||||
output stdout
|
||||
level WARN
|
||||
format console
|
||||
}
|
||||
|
||||
reverse_proxy /realtime http://backend:3000
|
||||
reverse_proxy /api/* http://backend:3000
|
||||
reverse_proxy /public/* http://backend:3000
|
||||
reverse_proxy /uploads/* http://backend:3000
|
||||
reverse_proxy /apidoc/* http://backend:3000
|
||||
reverse_proxy /* http://frontend:3001
|
19
docs/content/files/setup-docker/config.env
Normal file
19
docs/content/files/setup-docker/config.env
Normal file
|
@ -0,0 +1,19 @@
|
|||
# General settings
|
||||
HD_BASE_URL="https://md.example.com"
|
||||
HD_SESSION_SECRET="change_me_in_production"
|
||||
|
||||
# Database settings
|
||||
HD_DATABASE_TYPE="postgres"
|
||||
HD_DATABASE_HOST="db"
|
||||
HD_DATABASE_PORT="5432"
|
||||
HD_DATABASE_NAME="hedgedoc"
|
||||
HD_DATABASE_USER="hedgedoc"
|
||||
HD_DATABASE_PASS="password"
|
||||
|
||||
# Uploads
|
||||
HD_MEDIA_BACKEND="filesystem"
|
||||
HD_MEDIA_BACKEND_FILESYSTEM_UPLOAD_PATH="uploads/"
|
||||
|
||||
# Auth
|
||||
HD_AUTH_LOCAL_ENABLE_LOGIN="true"
|
||||
HD_AUTH_LOCAL_ENABLE_REGISTER="true"
|
38
docs/content/files/setup-docker/docker-compose.yml
Normal file
38
docs/content/files/setup-docker/docker-compose.yml
Normal file
|
@ -0,0 +1,38 @@
|
|||
services:
|
||||
backend:
|
||||
image: ghcr.io/hedgedoc/hedgedoc/backend:2.0-alpha
|
||||
volumes:
|
||||
- $PWD/.env:/usr/src/app/backend/.env
|
||||
- hedgedoc_uploads:/usr/src/app/backend/uploads
|
||||
|
||||
frontend:
|
||||
image: ghcr.io/hedgedoc/hedgedoc/frontend:2.0-alpha
|
||||
environment:
|
||||
HD_BASE_URL: "${HD_BASE_URL}"
|
||||
|
||||
db:
|
||||
image: postgres:15
|
||||
environment:
|
||||
POSTGRES_USER: "${HD_DATABASE_USER}"
|
||||
POSTGRES_PASSWORD: "${HD_DATABASE_PASS}"
|
||||
POSTGRES_DB: "${HD_DATABASE_NAME}"
|
||||
volumes:
|
||||
- hedgedoc_postgres:/var/lib/postgresql/data
|
||||
|
||||
proxy:
|
||||
image: caddy:latest
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
HD_BASE_URL: "${HD_BASE_URL}"
|
||||
ports:
|
||||
- "80:80"
|
||||
- "443:443"
|
||||
- "443:443/udp"
|
||||
volumes:
|
||||
- $PWD/Caddyfile:/etc/caddy/Caddyfile
|
||||
- caddy_data:/data
|
||||
|
||||
volumes:
|
||||
caddy_data:
|
||||
hedgedoc_uploads:
|
||||
hedgedoc_postgres:
|
Loading…
Add table
Add a link
Reference in a new issue