Admin Guide

You can find this repository here: https://adminguide.pages.dev.

Contribute

Feel free to open issues / pull requests.
Please validate that your changes work as intented!
You can start the mkdocs development server by running:

sudo ./serve.sh
# or
sudo sh ./serve.sh

The http server is then listening on port 8000.
Please review every script from the Internet before executing it!

Web Services are exposed to [::1]:8000
Secret Environment Variables are in an env_file (and not in the docker-compose.yml itself, to prevent leaks) with the following format:
```
# .servicename.env
KEY=value
```

environment variables should be in form of a YAML array, not an object:

environment:
  - "KEY=value"

instead of

# WRONG - please don't do this
environemnt:
  KEY: value
# WRONG

If possible the service should use either mariadb or postgresql. If it makes sense, other databases (e.g. sqlite) are also quiet fine.

YAML arrays should be quoted, regardless which data is stored:

volumes:
  - "/srv/service_name/data:/data"
ports:
  - "[::1]:8000:1234"
networks:
  - "default"
  - "database"