Skip to content

Commit

Permalink
Finish README
Browse files Browse the repository at this point in the history
Closes #3
  • Loading branch information
andrzejressel committed May 17, 2022
1 parent 16b5f69 commit c5d38b9
Showing 1 changed file with 25 additions and 2 deletions.
27 changes: 25 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,25 @@
# syncovery_collector
Prometheus Syncovery collector
# Syncovery prometheus exporter

Prometheus exporter for Syncovery backup software: https://www.syncovery.com/

## Quick start

```yaml
# docker-compose.yml
version: "3.9"
services:
syncovery-exporter:
image: ghcr.io/andrzejressel/syncovery-exporter:0.0.2
command:
- --url=SYNCOVERY_URL
```
## Setup Syncovery
Exporter using endpoint `/profile.json` which is available after adding `SkipProfileListAuth=1` to Syncovery config file. Because of latest changes related to encryption it has to be added a following way.

1. Create local file `syncovery.ini` with content `SkipProfileListAuth=1`
2. Login to Syncovery instance. Go to Program Settings
3. Select `Import Config Lines (INI Style)...` and choose created file.

You can limit IPs that endpoint is available to by using `SkipProfileListAuthForIP` option.

0 comments on commit c5d38b9

Please sign in to comment.