From 4bcfadc2fe67e5fcb7c537a497578557385cff59 Mon Sep 17 00:00:00 2001 From: bakito Date: Sun, 28 Mar 2021 10:30:00 +0200 Subject: [PATCH] update readme update readme --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index 414b01d..4e3a3a1 100644 --- a/README.md +++ b/README.md @@ -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 +``` \ No newline at end of file