This commit is contained in:
parent
9b40c02a98
commit
b8f6251221
24
README.md
24
README.md
@ -6,9 +6,27 @@ This is an exporter that exposes information gathered from Jellyfin for use by t
|
||||
|
||||
Requires Python 3.9 or better.
|
||||
|
||||
## Using docker
|
||||
|
||||
```
|
||||
docker pull git.hipstercat.fr/hipstercat/jellyfin-exporter:main
|
||||
```
|
||||
|
||||
Example: Display usage message:
|
||||
|
||||
```
|
||||
docker run -it --rm git.hipstercat.fr/hipstercat/jellyfin-exporter:main --help
|
||||
```
|
||||
|
||||
Example: Run the image with a mounted configuration file and published port:
|
||||
```
|
||||
docker run --init --name prometheus-jellyfin-exporter -d -p 127.0.0.1:9222:9222 -v /path/to/pve.yml:/etc/pve.yml git.hipstercat.fr/hipstercat/jellyfin-exporter:main
|
||||
```
|
||||
Prometheus Jellyfin Exporter will now be reachable at http://localhost:9222/.
|
||||
|
||||
## Usage
|
||||
|
||||
Visit http://localhost:9221/jellyfin?target=1.2.3.4 where 1.2.3.4
|
||||
Visit http://localhost:9222/jellyfin?target=1.2.3.4 where 1.2.3.4
|
||||
is the IP of the Jellyfin server to get metrics from. Specify the `module`
|
||||
request parameter, to choose which module to use from the config file.
|
||||
|
||||
@ -40,7 +58,7 @@ scrape_configs:
|
||||
- job_name: 'jellyfin'
|
||||
static_configs:
|
||||
- targets:
|
||||
- 192.168.1.2:9221 # Jellyfin server with Jellyfin exporter.
|
||||
- 192.168.1.2:9222 # Jellyfin server with Jellyfin exporter.
|
||||
metrics_path: /jellyfin
|
||||
params:
|
||||
module: [default]
|
||||
@ -63,5 +81,5 @@ scrape_configs:
|
||||
- source_labels: [__param_target]
|
||||
target_label: instance
|
||||
- target_label: __address__
|
||||
replacement: 127.0.0.1:9221 # Jellyfin exporter.
|
||||
replacement: 127.0.0.1:9222 # Jellyfin exporter.
|
||||
```
|
Loading…
Reference in New Issue
Block a user