From 6ade8d80872f7a787f190114cc58adfe62828d0c Mon Sep 17 00:00:00 2001 From: Roland Date: Tue, 18 Jun 2024 17:16:58 -0600 Subject: [PATCH] Adding API variables docs. --- docs/system/variables.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 docs/system/variables.md diff --git a/docs/system/variables.md b/docs/system/variables.md new file mode 100644 index 0000000..67909a7 --- /dev/null +++ b/docs/system/variables.md @@ -0,0 +1,33 @@ +# Variables + +## API Variables + +The behavior of the API can be modified by adding an environment variable file at `/opt/wrolpi/.env` + +### Downloads + +Download behavior can be modified by using these variables: + +| Name | Type | Default Value | +|---------------------------------|-------|---------------| +| `SIMULTANEOUS_DOWNLOAD_DOMAINS` | `Int` | 4 | + +### Database + +Connecting to the database can be modified using these variables: + +| Name | Type | Default Value | +|---------------|----------|---------------| +| `DB_HOST` | `String` | '127.0.0.1' | +| `DB_PORT` | `Int` | 5432 | +| `DB_NAME` | `String` | 'wrolpi' | +| `DB_USER` | `String` | 'wrolpi' | +| `DB_PASSWORD` | `String` | 'wrolpi' | + +### Raspberry Pi + +Raspberry Pi behavior can be modified by using these variables: + +| Name | Type | Default Value | +|-------------------------|----------|---------------| +| `DEFAULT_CPU_FREQUENCY` | `String` | 'ondemand' |