Yadciel/taskcafe
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Created Configuration (markdown)

Jordan Knott 2020-09-10 15:41:40 -05:00
parent a9fa6e1e1d
commit e8da099b34
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Configuration.md Normal file

@ -0,0 +1,22 @@
Taskcafe offers 3 different configuration methods.
## Environment Variables
The first way is through `env` variables.
The available env variables are
- `TASKCAFE_DATABASE_HOST`: The IP of the database (ex: 127.0.0.1)
- `TASKCAFE_DATABASE_USER`: The user for the database connection (ex: 'postgres')
- `TASKCAFE_DATABASE_PASSWORD`: The password for the database connection
- `TASKCAFE_DATABASE_NAME`: The name of the database (ex: 'taskcafe')
- `TASKCAFE_MIGRATE`: Setting this to `true` will run the database schema migrations on application startup
- `TASKCAFE_GENERAL_HOST`: The host and port to run the web service on (default is 0.0.0.0:3333)
## Config file
The same configuration options above can be set through a config file. See the [example config file](https://github.com/JordanKnott/taskcafe/blob/master/conf/taskcafe.example.toml) for more information.
## CLI flags
You can also set some of the config options through the CLI. Run `taskcafe web --help` for available options and flags.