diff --git a/config.yml.md b/config.yml.md index a2ef8d5..510a330 100644 --- a/config.yml.md +++ b/config.yml.md @@ -1,3 +1,15 @@ The `config.yml` file contains all of the Statping database settings and API keys/secrets. When Statping loads, it will attempt to open this file to parse it's core values. -### `config.yml` Settings +### `config.yml` Parameters +- connection: sqlite (sqlite, mysql, postgres) +- host: 0.0.0.0 (database host) +- user: root (database username) +- password: password123 (database password) +- database: root (Statping database name) +- port: 5432 (database port) +- api_key: 1d31a96a8b3... (Public API Key) +- api_secret: 18cd0a7373cb... (Private API Key) +- location: /Users/username/statping_dir (Statping absolute directory) + +The `location` setting will contain core files for Statping like, `logs`, `assets`, and should contain this `config.yml` file. +