github
/
statping
mirror of https://github.com/statping/statping
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated Environment Variables (markdown)

master
Hunter Long 2020-04-14 08:35:12 -07:00
parent 8b063e86e5
commit 6595164006
1 changed files with 42 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
Environment-Variables.md

@ -1,34 +1,44 @@
This page will list all environment variables that could be passed into Statping.
```
PORT - Set the outgoing port for the HTTP server (or use -port)
IP - Bind a specific IP address to the HTTP server (or use -ip)
VERBOSE - Display more logs in verbose mode. (1 - 4)
STATPING_DIR - Set a absolute path for the root path of Statping server (logs, assets, SQL db)
DB_CONN - Automatic Database connection (sqlite, postgres, mysql)
DB_HOST - Database hostname or IP address
DB_USER - Database username
DB_PASS - Database password
DB_PORT - Database port (5432, 3306, ...)
DB_DATABASE - Database connection's database name
POSTGRES_SSLMODE - Enable Postgres SSL Mode 'ssl_mode=VALUE' (enable/disable/verify-full/verify-ca)
DISABLE_LOGS - Disable viewing and writing to the log file (default is false)
GO_ENV - Run Statping in testmode, will bypass HTTP authentication (if set as 'test')
NAME - Set a name for the Statping status page
DESCRIPTION - Set a description for the Statping status page
DOMAIN - Set a URL for the Statping status page
ADMIN_USER - Username for administrator account (default: admin)
ADMIN_PASS - Password for administrator account (default: admin)
SASS - Set the absolute path to the sass binary location
USE_ASSETS - Automatically use assets from 'assets folder' (true/false)
HTTP_PROXY - Use a HTTP Proxy for HTTP Requests
AUTH_USERNAME - HTTP Basic Authentication username
AUTH_PASSWORD - HTTP Basic Authentication password
BASE_PATH - Set the base URL prefix (set to 'monitor' if URL is domain.com/monitor)
PREFIX - A Prefix for each value in Prometheus /metric exporter
API_KEY - Set a custom API Key for Statping
API_SECRET - Set a custom API Secret for API Authentication
MAX_OPEN_CONN - Set Maximum Open Connections for database server (default: 5)
MAX_IDLE_CONN - Set Maximum Idle Connections for database server
MAX_LIFE_CONN - Set Maximum Life Connections for database server
```
### Statping Server
- `PORT` - Set the outgoing port for the HTTP server (or use -port)
- `IP` - Bind a specific IP address to the HTTP server (or use -ip)
- `VERBOSE` - Display more logs in verbose mode. (1 - 4)
- `STATPING_DIR` - Set a absolute path for the root path of Statping server (logs, assets, SQL db)
- `DISABLE_LOGS` - Disable viewing and writing to the log file (default is false)
- `GO_ENV` - Run Statping in testmode, will bypass HTTP authentication (if set as 'test')
- `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 so we can see issues (default is false)
### Database
- `DB_CONN` - Automatic Database connection (sqlite, postgres, mysql) **Will automatically start if set to 'sqlite'**
- `DB_HOST` - Database hostname or IP address
- `DB_USER` - Database username
- `DB_PASS` - Database password
- `DB_PORT` - Database port (5432, 3306, ...)
- `DB_DATABASE` - Database connection's database name
- `POSTGRES_SSLMODE` - Enable Postgres SSL Mode 'ssl_mode=VALUE' (enable/disable/verify-full/verify-ca)
- `MAX_OPEN_CONN` - Set Maximum Open Connections for database server (default: 5)
- `MAX_IDLE_CONN` - Set Maximum Idle Connections for database server
- `MAX_LIFE_CONN` - Set Maximum Life Connections for database server
### Connection
- `BASE_PATH` - Set the base URL prefix (set to 'monitor' if URL is domain.com/monitor)
- `PREFIX` - A Prefix for each value in Prometheus /metric exporter
- `HTTP_PROXY` - Use a HTTP Proxy for HTTP Requests
- `AUTH_USERNAME` - HTTP Basic Authentication username
- `AUTH_PASSWORD` - HTTP Basic Authentication password
### Assets
- `SASS` - Set the absolute path to the sass binary location (find with `which sass`)
- `USE_ASSETS` - Automatically use assets from 'assets folder' (true/false)
### Automatic Fills
- `NAME` - Set a name for the Statping status page
- `DESCRIPTION` - Set a description for the Statping status page
- `DOMAIN` - Set a URL for the Statping status page
- `ADMIN_USER` - Username for administrator account (default: admin)
- `ADMIN_PASS` - Password for administrator account (default: admin)
- `API_KEY` - Set a custom API Key for Statping
- `API_SECRET` - Set a custom API Secret for API Authentication