simono41/prometheus-immich-exporter
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 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
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Dockerfile
View file

@ -14,7 +14,7 @@ RUN pip3 install .
ENV IMMICH_API_TOKEN="" ENV IMMICH_API_TOKEN=""
ENV IMMICH_HOST="" ENV IMMICH_HOST=""
ENV IMMICH_PORT="" ENV IMMICH_PORT="8080"
#has to be EXPORT_PORT 8000 or else it does not work, same applies to the env file #has to be EXPORT_PORT 8000 or else it does not work, same applies to the env file
ENV EXPORTER_PORT="8000" ENV EXPORTER_PORT="8000"
ENV EXPORTER_LOG_LEVEL="INFO" ENV EXPORTER_LOG_LEVEL="INFO"

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 ## How to use it
You can install this exporter with the following command: Here is an example docker run command
```bash
pip3 install prometheus-qbittorrent-exporter
```
Then you can run it with
``` ```
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
```
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
``` ```
Add this to your prometheus.yml Add this to your prometheus.yml
``` ```
- job_name: "immich_exporter" - job_name: "Immich_exporter"
static_configs: static_configs:
- targets: ['yourimmichexporter:port'] - targets: ['yourimmichexporter:port']
``` ```
@ -32,8 +20,9 @@ The application reads configuration using environment variables:
| Environment variable | Default | Description | | Environment variable | Default | Description |
|----------------------|----------|----------------------------------------------------| |----------------------|----------|----------------------------------------------------|
| `IMMICH_HOST` | | immich server hostname | | `IMMICH_HOST` | | Immich proxy url |
| `IMMICH_PORT` | | immich server port | | `IMMICH_PORT` | `8080` | Immich proxy port |
| `IMMICH_API_TOKEN` | | Immich API token, created from Immich dashboard |
| `EXPORTER_PORT` | `8000` | Exporter listening port | | `EXPORTER_PORT` | `8000` | Exporter listening port |
| `EXPORTER_LOG_LEVEL` | `INFO` | Log level. One of: `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL` | | `EXPORTER_LOG_LEVEL` | `INFO` | Log level. One of: `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL` |
| `METRICS_PREFIX` | `immich` | Prefix to add to all the metrics | | `METRICS_PREFIX` | `immich` | Prefix to add to all the metrics |

6
unraid/prometheus-immich-exporter.xml
View file

@ -21,8 +21,8 @@
<DonateText>If I made your day a little bit brighter, consider donating.</DonateText> <DonateText>If I made your day a little bit brighter, consider donating.</DonateText>
<DonateLink>https://www.paypal.com/donate/?hosted_button_id=DPDKED3T3BFV8</DonateLink> <DonateLink>https://www.paypal.com/donate/?hosted_button_id=DPDKED3T3BFV8</DonateLink>
<Requires/> <Requires/>
<Config Name="Host Port 1" Target="8000" Default="8028" Mode="tcp" Description="" Type="Port" Display="always" Required="false" Mask="false">8028</Config> <Config Name="Immich_exporter_port" Target="8000" Default="8000" Mode="tcp" Description="" Type="Port" Display="always" Required="false" Mask="false">8000</Config>
<Config Name="immich api token" Target="IMMICH_API_TOKEN" Default="" Mode="" Description="You need to log into to your immich admin account&#13;&#10;and create an api token in your settings" Type="Variable" Display="always" Required="false" Mask="false"/> <Config Name="immich api token" Target="IMMICH_API_TOKEN" Default="" Mode="" Description="You need to log into to your immich admin account&#13;&#10;and create an api token in your settings" Type="Variable" Display="always" Required="false" Mask="false"/>
<Config Name="immich_host" Target="IMMICH_HOST" Default="" Mode="" Description="example: 192.168.178.2" Type="Variable" Display="always" Required="false" Mask="false"/> <Config Name="immich_host" Target="IMMICH_HOST" Default="" Mode="" Description="Address to Immich_proxy, example: 192.168.178.2" Type="Variable" Display="always" Required="false" Mask="false"/>
<Config Name="immich port" Target="IMMICH_PORT" Default="" Mode="" Description="" Type="Variable" Display="always" Required="false" Mask="false"/> <Config Name="immich port" Target="IMMICH_PORT" Default="8080" Mode="" Description="Port for Immich_proxy" Type="Variable" Display="always" Required="false" Mask="false"/>
</Container> </Container>