mirror of
https://github.com/bakito/adguardhome-sync.git
synced 2024-09-20 06:46:12 +08:00
3139ad605f
* sync-actions * dns rewrites and filters * continue on filter error * servides * client settings * dns * dhcp * remove deprecated env var * fix client tests * tests * copy replica config * map continue on error * map env var with underscore
271 lines
7.7 KiB
Markdown
271 lines
7.7 KiB
Markdown
[](https://github.com/bakito/adguardhome-sync/actions/workflows/go.yml)
|
|
[](https://goreportcard.com/report/github.com/bakito/adguardhome-sync)
|
|
[](https://coveralls.io/github/bakito/adguardhome-sync?branch=main)
|
|
|
|
# AdGuardHome sync
|
|
|
|
Synchronize [AdGuardHome](https://github.com/AdguardTeam/AdGuardHome) config to replica instances.
|
|
|
|
## FAQ
|
|
|
|
Please check the wiki for [FAQ](https://github.com/bakito/adguardhome-sync/wiki/FAQ).
|
|
|
|
## Current sync features
|
|
|
|
- General Settings
|
|
- Filters
|
|
- Rewrites
|
|
- Services
|
|
- Clients
|
|
- DNS Config
|
|
- DHCP Config
|
|
|
|
By default, all features are enabled. Single features can be disabled in the config.
|
|
|
|
### Setup of initial instances
|
|
|
|
New AdGuardHome replica instances can be automatically installed if enabled via the config autoSetup. During automatic
|
|
installation, the admin interface will be listening on port 3000 in runtime.
|
|
|
|
To skip automatic setup
|
|
|
|
## Install
|
|
|
|
Get from [releases](https://github.com/bakito/adguardhome-sync/releases) or install from source
|
|
|
|
```bash
|
|
go install github.com/bakito/adguardhome-sync@latest
|
|
```
|
|
|
|
## Prerequisites
|
|
|
|
Both the origin instance must be initially setup via the AdguardHome installation wizard.
|
|
|
|
## Username / Password vs. Cookie
|
|
|
|
Some instances of AdGuard Home do not support basic authentication. For instance, many routers with built-in Adguard
|
|
Home support do not. If this is the case, a valid cookie may be provided instead. If the router protects the AdGuard
|
|
instance behind its own authentication, the cookie from an authenticated request may allow the sync to succeed.
|
|
|
|
- This has been tested successfully against GL.Inet routers with AdGuard Home.
|
|
- Note: due to the short validity of cookies, this approach is likely only suitable for one-time syncs
|
|
|
|
## Run Linux/Mac
|
|
|
|
```bash
|
|
|
|
export LOG_LEVEL=info
|
|
export ORIGIN_URL=https://192.168.1.2:3000
|
|
export ORIGIN_USERNAME=username
|
|
export ORIGIN_PASSWORD=password
|
|
# export ORIGIN_COOKIE=Origin-Cookie-Name=CCCOOOKKKIIIEEE
|
|
export REPLICA_URL=http://192.168.1.3
|
|
export REPLICA_USERNAME=username
|
|
export REPLICA_PASSWORD=password
|
|
# export REPLICA_COOKIE=Replica-Cookie-Name=CCCOOOKKKIIIEEE
|
|
|
|
# run once
|
|
adguardhome-sync run
|
|
|
|
# run as daemon
|
|
adguardhome-sync run --cron "*/10 * * * *"
|
|
```
|
|
|
|
## Run Windows
|
|
|
|
```bash
|
|
@ECHO OFF
|
|
@TITLE AdGuardHome-Sync
|
|
|
|
REM set LOG_LEVEL=debug
|
|
set LOG_LEVEL=info
|
|
REM set LOG_LEVEL=warn
|
|
REM set LOG_LEVEL=error
|
|
|
|
set ORIGIN_URL=http://192.168.1.2:3000
|
|
set ORIGIN_USERNAME=username
|
|
set ORIGIN_PASSWORD=password
|
|
# set ORIGIN_COOKIE=Origin-Cookie-Name=CCCOOOKKKIIIEEE
|
|
|
|
set REPLICA_URL=http://192.168.2.2:3000
|
|
set REPLICA_USERNAME=username
|
|
set REPLICA_PASSWORD=password
|
|
# set REPLICA_COOKIE=Replica-Cookie-Name=CCCOOOKKKIIIEEE
|
|
|
|
set FEATURES_DHCP=false
|
|
set FEATURES_DHCP_SERVERCONFIG=false
|
|
set FEATURES_DHCP_STATICLEASES=false
|
|
|
|
# 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 \
|
|
ghcr.io/bakito/adguardhome-sync:latest
|
|
```
|
|
|
|
## docker compose
|
|
|
|
### config file
|
|
|
|
```yaml
|
|
---
|
|
version: "2.1"
|
|
services:
|
|
adguardhome-sync:
|
|
image: ghcr.io/bakito/adguardhome-sync
|
|
container_name: adguardhome-sync
|
|
command: run --config /config/adguardhome-sync.yaml
|
|
volumes:
|
|
- /path/to/appdata/config/adguardhome-sync.yaml:/config/adguardhome-sync.yaml
|
|
ports:
|
|
- 8080:8080
|
|
restart: unless-stopped
|
|
```
|
|
|
|
### env
|
|
|
|
```yaml
|
|
---
|
|
version: "2.1"
|
|
services:
|
|
adguardhome-sync:
|
|
image: ghcr.io/bakito/adguardhome-sync
|
|
container_name: adguardhome-sync
|
|
command: run
|
|
environment:
|
|
LOG_LEVEL: "info"
|
|
ORIGIN_URL: "https://192.168.1.2:3000"
|
|
# ORIGIN_WEBURL: "https://some-other.url" # used in the web interface (default: <origin-url>
|
|
|
|
ORIGIN_USERNAME: "username"
|
|
ORIGIN_PASSWORD: "password"
|
|
REPLICA_URL: "http://192.168.1.3"
|
|
REPLICA_USERNAME: "username"
|
|
REPLICA_PASSWORD: "password"
|
|
REPLICA1_URL: "http://192.168.1.4"
|
|
REPLICA1_USERNAME: "username"
|
|
REPLICA1_PASSWORD: "password"
|
|
REPLICA1_APIPATH: "/some/path/control"
|
|
# REPLICA1_WEBURL: "https://some-other.url" # used in the web interface (default: <replica-url>
|
|
# REPLICA1_AUTOSETUP: true # if true, AdGuardHome is automatically initialized.
|
|
# REPLICA1_INTERFACENAME: 'ens18' # use custom dhcp interface name
|
|
# REPLICA1_DHCPSERVERENABLED: true/false (optional) enables/disables the dhcp server on the replica
|
|
CRON: "*/10 * * * *" # run every 10 minutes
|
|
RUNONSTART: true
|
|
# CONTINUEONERROR: false # If enabled, the synchronisation task will not fail on single errors, but will log the errors and continue
|
|
|
|
# Configure the sync API server, disabled if api port is 0
|
|
API_PORT: 8080
|
|
|
|
# Configure sync features; by default all features are enabled.
|
|
# FEATURES_GENERALSETTINGS: true
|
|
# FEATURES_QUERYLOGCONFIG: true
|
|
# FEATURES_STATSCONFIG: true
|
|
# FEATURES_CLIENTSETTINGS: true
|
|
# FEATURES_SERVICES: true
|
|
# FEATURES_FILTERS: true
|
|
# FEATURES_DHCP_SERVERCONFIG: true
|
|
# FEATURES_DHCP_STATICLEASES: true
|
|
# FEATURES_DNS_SERVERCONFIG: true
|
|
# FEATURES_DNS_ACCESSLISTS: true
|
|
# FEATURES_DNS_REWRITES: true
|
|
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 * * * *"
|
|
|
|
# runs the synchronisation on startup
|
|
runOnStart: true
|
|
|
|
# If enabled, the synchronisation task will not fail on single errors, but will log the errors and continue
|
|
continueOnError: false
|
|
|
|
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
|
|
# cookie: Origin-Cookie-Name=CCCOOOKKKIIIEEE
|
|
|
|
# replica instance (optional, if only one)
|
|
replica:
|
|
# url of the replica instance
|
|
url: http://192.168.1.3
|
|
username: username
|
|
password: password
|
|
# cookie: Replica-Cookie-Name=CCCOOOKKKIIIEEE
|
|
# webURL: "https://some-other.url" # used in the web interface (default: <origin-url>
|
|
|
|
# replicas instances (optional, if more than one)
|
|
replicas:
|
|
# url of the replica instance
|
|
- url: http://192.168.1.3
|
|
username: username
|
|
password: password
|
|
# cookie: Replica1-Cookie-Name=CCCOOOKKKIIIEEE
|
|
- url: http://192.168.1.4
|
|
username: username
|
|
password: password
|
|
# cookie: Replica2-Cookie-Name=CCCOOOKKKIIIEEE
|
|
# autoSetup: true # if true, AdGuardHome is automatically initialized.
|
|
# webURL: "https://some-other.url" # used in the web interface (default: <replica-url>
|
|
|
|
# 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
|
|
# enable api dark mode
|
|
darkMode: true
|
|
|
|
# Configure sync features; by default all features are enabled.
|
|
features:
|
|
generalSettings: true
|
|
queryLogConfig: true
|
|
statsConfig: true
|
|
clientSettings: true
|
|
services: true
|
|
filters: true
|
|
dhcp:
|
|
serverConfig: true
|
|
staticLeases: true
|
|
dns:
|
|
serverConfig: true
|
|
accessLists: true
|
|
rewrites: true
|
|
```
|
|
|
|
## Log Level
|
|
|
|
The log level can be set with the environment variable: LOG_LEVEL
|
|
|
|
The following log levels are supported (default: info)
|
|
|
|
- debug
|
|
- info
|
|
- warn
|
|
- error
|