mirror of
https://github.com/bakito/adguardhome-sync.git
synced 2024-09-20 06:46:12 +08:00
111 lines
2.5 KiB
Markdown
111 lines
2.5 KiB
Markdown
[](https://github.com/bakito/adguardhome-sync/actions/workflows/go.yml) [](https://goreportcard.com/report/github.com/bakito/adguardhome-sync)
|
|
|
|
# AdGuardHome sync
|
|
|
|
Synchronize [AdGuardHome](https://github.com/AdguardTeam/AdGuardHome) config to a replica instance.
|
|
|
|
## Current sync features
|
|
|
|
- General Settings
|
|
- Filters
|
|
- Rewrites
|
|
- Services
|
|
- Clients
|
|
|
|
## Install
|
|
|
|
```bash
|
|
go get -u github.com/bakito/adguardhome-sync
|
|
```
|
|
|
|
## Prerequisites
|
|
|
|
Both the origin and replica mist be initially setup via the Adguard Home installation wizard.
|
|
|
|
## Run
|
|
|
|
```bash
|
|
|
|
export ORIGIN_URL=https://192.168.1.2:3000
|
|
export ORIGIN_USERNAME=username
|
|
export ORIGIN_PASSWORD=password
|
|
export REPLICA_URL=http://192.168.1.3
|
|
export REPLICA_USERNAME=username
|
|
export REPLICA_PASSWORD=password
|
|
|
|
# run once
|
|
adguardhome-sync run
|
|
|
|
# run as daemon
|
|
adguardhome-sync run --cron "*/10 * * * *"
|
|
```
|
|
|
|
## docker cli
|
|
|
|
```bash
|
|
docker run -d \
|
|
--name=adguardhome-sync \
|
|
-p 8080:8080 \
|
|
-v /path/to/appdata/config/adguardhome-sync.yaml:/config/adguardhome-sync.yaml \
|
|
--restart unless-stopped \
|
|
quay.io/bakito/adguardhome-sync:latest
|
|
```
|
|
|
|
## docker compose
|
|
```yaml
|
|
---
|
|
version: "2.1"
|
|
services:
|
|
adguardhome-sync:
|
|
image: quay.io/bakito/adguardhome-sync
|
|
container_name: adguardhome-sync
|
|
volumes:
|
|
- /path/to/appdata/config/adguardhome-sync.yaml:/config/adguardhome-sync.yaml
|
|
ports:
|
|
- 8080:8080
|
|
restart: unless-stopped
|
|
```
|
|
|
|
### Config file
|
|
|
|
location: $HOME/.adguardhome-sync.yaml
|
|
|
|
```yaml
|
|
# cron expression to run in daemon mode. (default; "" = runs only once)
|
|
cron: "*/10 * * * *"
|
|
|
|
origin:
|
|
# url of the origin instance
|
|
url: https://192.168.1.2:3000
|
|
# apiPath: define an api path if other than "/control"
|
|
# insecureSkipVerify: true # disable tls check
|
|
username: username
|
|
password: password
|
|
|
|
# replica instance (optional, if only one)
|
|
replica:
|
|
# url of the replica instance
|
|
url: http://192.168.1.3
|
|
username: username
|
|
password: password
|
|
|
|
# replicas instances (optional, if more than one)
|
|
replicas:
|
|
# url of the replica instance
|
|
- url: http://192.168.1.3
|
|
username: username
|
|
password: password
|
|
- url: http://192.168.1.4
|
|
username: username
|
|
password: password
|
|
|
|
# Configure the sync API server, disabled if api port is 0
|
|
api:
|
|
# Port, default 8080
|
|
port: 8080
|
|
# if username and password are defined, basic auth is applied to the sync API
|
|
username: username
|
|
password: password
|
|
|
|
```
|