From e8da099b341e9f2d9cc513972a1da6f99891854d Mon Sep 17 00:00:00 2001 From: Jordan Knott Date: Thu, 10 Sep 2020 15:41:40 -0500 Subject: [PATCH] Created Configuration (markdown) --- Configuration.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 Configuration.md diff --git a/Configuration.md b/Configuration.md new file mode 100644 index 0000000..4aa3086 --- /dev/null +++ b/Configuration.md @@ -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. \ No newline at end of file