Readme: ankisyncd.conf vs https://github.com/ankicommunity/anki-sync-server/tree/develop/config about ankicommunity-sync-server HOT 1 CLOSED

Hi @dreamflasher,

Thank you for the offer to update the README. I just want to make sure that it's clear how configuration works. And if you can update the README accordingly.

Anki-sync-server supports both a config file and environment variables. See how they work below.

1. ankisyncd.conf (Config file)

• The config file can be found here: src/ankisyncd.conf.
• Copying the config file from src/ankisyncd.conf to src/ankisyncd/ankisyncd.conf will allow you to configure the server.

3. .env.local (Environment variables)

• The environment variables can be found here: config/.env.example.
• The file also includes other development variables, but the notable ones are the ones with the prefix ANKISYNCD_
• Environment variables will override the config files values (which is why I recommend you use them)
• This is what we use in the Docker images (see: https://github.com/ankicommunity/anki-devops-services/blob/develop/services/anki-sync-server/examples/docker-compose.yml).
• Copying the config file from config/.env.example to config/.env.local will allow you to configure the server when using the make commands
• You can also set it when running the server e.g. ANKISYNCD_PORT=5001 make run
• The above two options are useful for development. But if you're only going for usage, you can also set it globally by adding it to your ~/.bashrc file e.g. export ANKISYNCD_PORT=50001

Does that make sense?

Config files are typically better client-side i.e. when you're running it on your laptop. Environment variables are typically better server-side i.e. when you're using Docker.

I tend to prefer environment variables because they're global which is useful if you need to share configuration between different services. But at the current point, both are valid options on how to configure the server.

from ankicommunity-sync-server.