artin/exportarr
1
0
Fork 0
mirror of https://github.com/onedr0p/exportarr.git synced 2026-02-06 10:57:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update readme

Browse Source
This commit is contained in:
ᗪєνιη ᗷυнʟ 2021-03-22 08:38:52 -04:00 committed by GitHub
parent 96c742616e
commit ddf1f0e86a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -6,6 +6,22 @@ AIO Prometheus Exporter for Sonarr, Radarr or Lidarr
This is Prometheus Exporter will export metrics gathered from Sonarr, Radarr, or Lidarr. This only supports v1 API of Lidarr and v3 APIs for Sonarr and Radarr. It will not gather metrics from all 3 at once, and instead you need to tell the exporter what metrics you want. Be sure to see the examples below for more information.
## Configuration
| Environment Variable | CLI Flag | Description | Default | Required |
|:----------------------------:|--------------------------------|----------------------------------------------------------------|-----------|:--------:|
| `PORT` | `--port` or `-p` | The port exportarr will listen on | | ✅ |
| `URL` | `--url` or `-u` | The full URL to Sonarr, Radarr, or Lidarr | | ✅ |
| `APIKEY` | `--api-key` or `-a` | API Key for Sonarr, Radarr or Lidarr | | ❌ |
| `CONFIG` | `--config` or `-c` | Path to Sonarr, Radarr or Lidarr's `config.xml` (advanced) | | ❌ |
| `INTERFACE` | `--interface` or `-i` | The interface IP exportarr will listen on | `0.0.0.0` | ❌ |
| `LOG_LEVEL` | `--log-level` or `-l` | Set the default Log Level | `INFO` | ❌ |
| `DISABLE_SSL_VERIFY` | `--disable-ssl-verify` | Set to `true` to disable SSL verification | `false` | ❌ |
| `BASIC_AUTH_PASSWORD` | `--basic-auth-password` | Set to your basic auth password | | ❌ |
| `BASIC_AUTH_USERNAME` | `--basic-auth-username` | Set to your basic auth username | | ❌ |
| `ENABLE_ADDITIONAL_METRICS` | `--enable-additional-metrics` | Set to `true` to enable gathering of additional metrics (slow) | `false` | ❌ |
| `ENABLE_UNKNOWN_QUEUE_ITEMS` | `--enable-unknown-queue-items` | Set to `true` to enable gathering unknown queue items | `false` | ❌ |
## Usage
### Run with Docker Compose
@ -16,6 +32,8 @@ See examples in the [examples/compose](./examples/compose/) directory
See examples in the [examples/kubernetes](./examples/kubernetes/) directory.
This exporter is also included in the Lidarr, Radarr, and Sonarr helm charts located over at (k8s-at-home/charts)[https://github.com/k8s-at-home/charts]
### Run with Docker CLI
#### Sonarr
@ -103,19 +121,3 @@ Visit http://127.0.0.1:9708/metrics to see Radarr metrics
```
Visit http://127.0.0.1:9709/metrics to see Radarr metrics
## Configuration
| Environment Variable | CLI Flag | Description | Default | Required |
|:----------------------------:|--------------------------------|----------------------------------------------------------------|-----------|:--------:|
| `PORT` | `--port` or `-p` | The port exportarr will listen on | | ✅ |
| `URL` | `--url` or `-u` | The full URL to Sonarr, Radarr, or Lidarr | | ✅ |
| `APIKEY` | `--api-key` or `-a` | API Key for Sonarr, Radarr or Lidarr | | ❌ |
| `CONFIG` | `--config` or `-c` | Path to Sonarr, Radarr or Lidarr's `config.xml` (advanced) | | ❌ |
| `INTERFACE` | `--interface` or `-i` | The interface IP exportarr will listen on | `0.0.0.0` | ❌ |
| `LOG_LEVEL` | `--log-level` or `-l` | Set the default Log Level | `INFO` | ❌ |
| `DISABLE_SSL_VERIFY` | `--disable-ssl-verify` | Set to `true` to disable SSL verification | `false` | ❌ |
| `BASIC_AUTH_PASSWORD` | `--basic-auth-password` | Set to your basic auth password | | ❌ |
| `BASIC_AUTH_USERNAME` | `--basic-auth-username` | Set to your basic auth username | | ❌ |
| `ENABLE_ADDITIONAL_METRICS` | `--enable-additional-metrics` | Set to `true` to enable gathering of additional metrics (slow) | `false` | ❌ |
| `ENABLE_UNKNOWN_QUEUE_ITEMS` | `--enable-unknown-queue-items` | Set to `true` to enable gathering unknown queue items | `false` | ❌ |