diff --git a/README.md b/README.md index 996ca95..6869e84 100644 --- a/README.md +++ b/README.md @@ -137,8 +137,9 @@ You can specify configuration options either via a config file (default: `config | YAML key / Env. variable | Default | Description | |------------------------------------------------------------------------------|--------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `env` /
`ENVIRONMENT` | `dev` | Whether to use development- or production settings | -| `app.aggregation_time` /
`WAKAPI_AGGREGATION_TIME` | `02:15` | Time of day at which to periodically run summary generation for all users | -| `app.report_time_weekly` /
`WAKAPI_REPORT_TIME_WEEKLY` | `fri,18:00` | Week day and time at which to send e-mail reports | +| `app.aggregation_time` /
`WAKAPI_AGGREGATION_TIME` | `0 15 2 * * *` | Time of day at which to periodically run summary generation for all users | +| `app.report_time_weekly` /
`WAKAPI_REPORT_TIME_WEEKLY` | `0 0 18 * * 5` | Week day and time at which to send e-mail reports | +| `app.leaderboard_generation_time` /
`WAKAPI_LEADERBOARD_GENERATION_TIME` | `0 0 6 * * *,0 0 18 * * *` | One or multiple times of day at which to re-calculate the leaderboard | | `app.import_batch_size` /
`WAKAPI_IMPORT_BATCH_SIZE` | `50` | Size of batches of heartbeats to insert to the database during importing from external services | | `app.inactive_days` /
`WAKAPI_INACTIVE_DAYS` | `7` | Number of days after which to consider a user inactive (only for metrics) | | `app.heartbeat_max_age /`
`WAKAPI_HEARTBEAT_MAX_AGE` | `4320h` | Maximum acceptable age of a heartbeat (see [`ParseDuration`](https://pkg.go.dev/time#ParseDuration)) | diff --git a/config.default.yml b/config.default.yml index 7a7c9c4..b3b48fe 100644 --- a/config.default.yml +++ b/config.default.yml @@ -12,12 +12,12 @@ server: public_url: http://localhost:3000 # required for links (e.g. password reset) in e-mail app: - aggregation_time: '02:15' # time at which to run daily aggregation batch jobs - leaderboard_generation_time: '06:00;18:00' # time at which to run daily aggregation batch jobs - report_time_weekly: 'fri,18:00' # time at which to fan out weekly reports (format: ',') - inactive_days: 7 # time of previous days within a user must have logged in to be considered active - import_batch_size: 50 # maximum number of heartbeats to insert into the database within one transaction - heartbeat_max_age: '4320h' # maximum acceptable age of a heartbeat (see https://pkg.go.dev/time#ParseDuration) + aggregation_time: '0 15 2 * * *' # time at which to run daily aggregation batch jobs + leaderboard_generation_time: '0 0 6 * * *,0 0 18 * * *' # times at which to re-calculate the leaderboard + report_time_weekly: '0 0 18 * * 5' # time at which to fan out weekly reports (extended cron) + inactive_days: 7 # time of previous days within a user must have logged in to be considered active + import_batch_size: 50 # maximum number of heartbeats to insert into the database within one transaction + heartbeat_max_age: '4320h' # maximum acceptable age of a heartbeat (see https://pkg.go.dev/time#ParseDuration) custom_languages: vue: Vue jsx: JSX