Add examples and clear explanations of configuration for syncstorage and tokenserver #1989
Description
Currently, we provide a pretty bare-bones example config file. Configuration is particularly challenging with syncstorage-rs given that it houses the code for both syncstorage and tokenserver, and that there are multiple mix and match options for databases.
It is not obvious what needs to be set in order to run the service. Publicly-accessible code docs docs a la https://mozilla-hub.atlassian.net/browse/SYNC-3341 will help a lot (users will be able to see all of the settings in the Settings structs along with their doc comments), but it would be useful to give comprehensive examples of how to build and configure the following:
- Syncstorage with Postgres
- Syncstorage with Spanner
- Tokenserver with Postgres
- Tokenserver with MySQL
- Syncstorage and Tokenserver together
A few ideas:
- Add more example config files to support running different server configurations out of the box.
- Ex. a local.postgres.toml
- Expand upon the Makefile to add more support for running different server configurations out of the box
- Explore using cargo make to make building and running the app easier
- Make using Docker locally easier (build caching?)
┆Issue is synchronized with this Jira Task