studium/config.example.yml
Antoine Pelletier ce985ef784
Some checks failed
build / image (push) Failing after 31s
wip
2026-10-24 12:55:18 +02:00

58 lines
2.3 KiB
YAML

# Copy to config.yml (gitignored) and adapt.
# Every value can also be given as an environment variable, e.g. APP__SERVER__PORT=3000
server:
address: 0.0.0.0
port: 3000
postgres:
host: localhost
port: 5432
user: postgres
password: postgres
name: studium
# Directory containing the built frontend (frontend/dist after `npm run build`)
frontend_dir: frontend/dist
# Where the files of the courses and associations are stored (lecture notes and their
# pdf...): a folder per person, then one per course: jdoe/Cours/CS-477 Advanced OS/Notes/...
# A local directory, or the NAS mounted.
storage_dir: storage
# Rendering of the lecture notes to pdf (needs pandoc and pdflatex)
notes:
# Directory of template.tex, box-filter.lua and assets/
template_dir: LaTeX_pdf
# Relative to template_dir
logo: assets/epfl.png
# The app must be behind Authelia (forward auth of the reverse proxy), which gives the
# login of the person in the Remote-User header: each person has their own courses,
# calendars and files. The app must not be reachable without going through Authelia,
# or anyone could send this header.
auth:
# Login used for the requests without Remote-User. Only for development, never in
# production: anyone reaching the app would be this person.
# default_user: jdoe
# Where the "log out" link leads: the logout page of Authelia
# logout_url: https://auth.example.com/logout
# Secret the reverse proxy sends in the X-Proxy-Secret header: the requests without it
# are refused. Set it whenever the port of the app can be reached by anything else than
# the proxy (e.g. `openssl rand -hex 32`).
# proxy_secret: ...
# Optional: the focus sessions of the pomodoro can also be counted in TimeTagger, tagged
# with the course code, the tags and the name of the task, for the people with a token.
# timetagger:
# # https://timetagger.app/api/v2 by default, or the api of your own server
# url: https://timetagger.app/api/v2
# Settings of each person, by login, all optional
# users:
# jdoe:
# # Shown in the header of the notes (the name given by Authelia by default)
# student_name: Jane Doe
# student_id: "123456"
# # Api token, from the account page of TimeTagger. Without it, the time is only
# # counted in the app.
# timetagger_token: ...