Updated Environment Variables (markdown)

master
Hunter Long 2020-08-03 03:40:58 -07:00
parent 3c4954d22d
commit d2be44490b
1 changed files with 5 additions and 3 deletions

@ -10,12 +10,14 @@ This page will list all environment variables that could be passed into Statping
- `REMOVE_AFTER` - Automatically delete records after time (default 3 months, '12h = 12 hours')
- `CLEANUP_INTERVAL` - Interval to check for old records (default 1 hour, '1h = 1 hour')
- `ALLOW_REPORTS` - Send Statping anonymous [error reports](https://sentry.io/) so we can see issues (default is false)
- `SERVER_PORT` - Port number to run Statping HTTP server on (or use -p/--port)
### Automatic SSL Certificate
With LetsEncrypt enabled, Statping will run through the SSL process and create the SSL certs in the `certs` folder. Read more about the SSL Process on the [SSL Wiki](https://github.com/statping/statping/wiki/SSL).
- `LETSENCRYPT_ENABLE` - Set to **true** to have LetsEncrypt enabled. (defaults to false)
- `LETSENCRYPT_HOST` - Domain to generate SSL certificate
- `LETSENCRYPT_EMAIL` - Email address that gets sent with the LetsEncrypt Request
- `LETSENCRYPT_LOCAL` - Set for LetsEncrypt testing
### Database
- `DB_CONN` - Database connection (sqlite, postgres, mysql) **Will automatically start if set to 'sqlite'**