Server configuration

Server configuration, managed by docker-compose, with comprehensive default configuration.

Run

SITE=tom.moulard.org docker-compose up -d

Now you have your own server configuration.

To be a little more consistent with the management, you can use a .env file and do:

cp .env.default .env

And edit the .env file to use the correct configuration.

The docker-compose function gather all docker-compose files in order to have the whole configuration in one place (see docker-compose config).

Tear down

docker-compose down

Services list

There should be only one service by folder: For example, le folder traefik/ contains all the necessary configuration to run the traefik service.

Thus each folder represent an available service.

The directory must follow the following architecture:

service/
├── conf
│   └── ...
├── data
│   └── ...
├── docker-compose.servicename.yml
├── logs
│   ├── access.log
│   └── error.log
└── README.md

If the service you are adding can use volumes:

• data/, is where to store to service data
• conf/, is where to store to service configuration
• logs/, is where to store to service logs (others than Docker logs)

Feel free to do a Pull Request to add your ideas.

more ideas

Configuration

Don't forget to change:

• db passwords (might not be needed since they are beyond the reverse proxy)
• VPN secrets (if none provided, they are generated directly).

Configuration files are: docker-compose.yml, nginx.conf

To set the password:

echo "USERS=$(htpasswd -nB $USER)" >> .env

You can add a new set of credentials by editing the .env file like

USERS=toto:pass,tata:pass, ...

The .env.default is generated using this command:

grep '${' **/docker-compose.*.yml | sed "s/.*\${\(.*\)}.*/\1/g" | cut -d":" -f 1 | sort -u | sort | xargs -I % echo "%=" >> .env.default

For local developments

Edit the file /etc/hosts to provide the reverse proxy with good URLs.

For example, adding this in your /etc/hosts will allow to run and debug the Traefik service locally:

127.0.0.1   traefik.moulard.org

Scaling up

docker-compose scale nginx=2

Tests

Lint

! Warning: This is enforced for all PRs.

We are using yamllint to lint our yaml files. You can install it by looking at the official documentation.

Once installed, you can run the following command to lint all the yaml files:

yamllint .

docker-compose config

! Warning: This is enforced for all PRs.

You can run the following command to check that the docker-compose files are correctly written:

./test.sh

It tests that:

• all docker-compose files are valid
• all docker-compose files are parsable
• all docker-compose files are consistent with the test_config.yml file
• all environment variables are set inside the .env.default file

Once this shell scritp is run, if the tests failes, you can see a bunch of modified files (e.g., test_config.yml) that indicates what is wrong.

Note that the GitHub Action will run this script for you, and provides a patch.patch file that should solve most of your issues.

Authors

Main author:

• Tom

Gitlab helper:

• michel_k

Discord MusicBot/minecraft:

• huvell_m, see PR #6