Created Environment Variables (markdown)

master
Hunter Long 2020-01-12 19:11:43 -08:00
parent 4b79040a9f
commit bd13e48647
1 changed files with 26 additions and 0 deletions

26
Environment-Variables.md Normal file

@ -0,0 +1,26 @@
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)
DISABLE_LOGS - Disable viewing and writing to the log file (default is false)
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)
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
HTTP_PROXY - Use a HTTP Proxy for HTTP Requests
AUTH_USERNAME - HTTP Basic Authentication username
AUTH_PASSWORD - HTTP Basic Authentication password
```