update readme

update readme
This commit is contained in:
bakito 2021-03-28 10:30:00 +02:00
parent 36bb6b1957
commit 4bcfadc2fe
No known key found for this signature in database
GPG key ID: FAF93C1C384DD6B4

View file

@ -1,3 +1,33 @@
[![Go](https://github.com/bakito/adguardhome-sync/actions/workflows/go.yml/badge.svg)](https://github.com/bakito/adguardhome-sync/actions/workflows/go.yml) [![Go Report Card](https://goreportcard.com/badge/github.com/bakito/adguardhome-sync)](https://goreportcard.com/report/github.com/bakito/adguardhome-sync)
# AdGuardHome sync
Synchronize [AdGuardHome](https://github.com/AdguardTeam/AdGuardHome) config to a replica instance.
This is still work in progress. Changes on how parameters are provided will change.
## Current sync features
- Filters
- Rewrites
- Services
- Clients
## Install
```bash
go get -u github.com/bakito/adguardhome-sync
```
## Run
```bash
export ORIGIN_API_URL=https://192.168.1.2:3000/control
export ORIGIN_USERNAME=username
export ORIGIN_PASSWORD=password
export REPLICA_API_URL=http://192.168.1.3/control
export REPLICA_USERNAME=username
export REPLICA_PASSWORD=password
adguardhome-sync
```