maxenceg2m/prometheus-immich-exporter
1
0
Fork 0
mirror of https://github.com/MaxenceG2M/prometheus-immich-exporter.git synced 2025-12-09 23:15:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Further edit of readme

Browse Source 
- Added better description on UnRaid template
- Added Immich_api_token to readme
- Populated default Immich_port 8080 in Dockerfile
- Clarified that it's the Immich Proxy that you need to connect to, not Immich Server
This commit is contained in:
Vegard Fladby
2023-07-20 18:15:05 +02:00
parent fb668bf3e2
commit 513856beff
3 changed files with 10 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -5,26 +5,14 @@ A prometheus exporter for Immich. Get metrics from a server and offers them in a
## How to use it
You can install this exporter with the following command:
```bash
pip3 install prometheus-qbittorrent-exporter
```
Then you can run it with
Here is an example docker run command
```
immich-exporter
```
Another option is to run it in a docker container. Here is an example docker run command
```
docker run -e IMMICH_PORT=8010 -e IMMICH_HOST=192.168.178.1 -p 8000:8000 friendlyfriend/prometheus-immich-exporter
docker run -e IMMICH_PORT=8080 -e IMMICH_HOST=192.168.178.1 -e IMMICH_API_TOKEN=TOKEN -p 8000:8000 friendlyfriend/prometheus-immich-exporter
```
Add this to your prometheus.yml
```
- job_name: "immich_exporter"
- job_name: "Immich_exporter"
static_configs:
- targets: ['yourimmichexporter:port']
```
@@ -32,8 +20,9 @@ The application reads configuration using environment variables:
| Environment variable | Default | Description |
|----------------------|----------|----------------------------------------------------|
| `IMMICH_HOST` | | immich server hostname |
| `IMMICH_PORT` | | immich server port |
| `IMMICH_HOST` | | Immich proxy url |
| `IMMICH_PORT` | `8080` | Immich proxy port |
| `IMMICH_API_TOKEN` | | Immich API token, created from Immich dashboard |
| `EXPORTER_PORT` | `8000` | Exporter listening port |
| `EXPORTER_LOG_LEVEL` | `INFO` | Log level. One of: `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL` |
| `METRICS_PREFIX` | `immich` | Prefix to add to all the metrics |