atoy3731/adguard-sync
1
1
Fork 0
mirror of https://github.com/atoy3731/adguard-sync.git synced 2024-09-20 06:56:01 +08:00
Code Issues Packages Projects Releases Wiki Activity
adguard-sync/README.md
Adam Toy cd8338fbd0
Add capability for advanced sync of other elements (#4) 
* Add capability for advanced sync of other elements

* Revert default refresh interval

* Add fix for secondary_blocked_services

* Add logging for modified entry

* Update language

* Bug fix
2021-11-06 16:52:23 -04:00

2.3 KiB
Raw Blame History

AdGuard Sync

Docker

This project will sync entries between a Primary and Secondary AdGuard Home instance using the API.

This is useful if you're dependent on local DNS and want to ensure relative High Availability.

How to Run

AdGuard Sync is packaged as a Docker image and can be ran anywhere with access to your instances, though it is advisable to run this on the same instance that is running your Primary Adguard instance. This makes your primary instance the "source of truth" for local DNS, but allows your secondary instance to stay in sync as a fallback. Once running, set your router DNS to point to both your primary and secondary. You can update the docker-compose.yaml file with your values based on the following:

Variable Required Description Default
ADGUARD_PRIMARY Yes Primary base URL for the primary AdGuard instance (ie. http://dns01.example.com) N/A
ADGUARD_SECONDARY Yes Secondary base URL for the primary AdGuard instance (ie. http://dns02.example.com) N/A
ADGUARD_USER Yes Username to log into your AdGuard instances. N/A
ADGUARD_PASS Yes Password to log into your AdGuard instances. N/A
SECONDARY_ADGUARD_USER No Username to log into your secondary AdGuard instance. Only necessary if credentials are different between primary and secondary Value of 'ADGUARD_USER'
SECONDARY_ADGUARD_PASS No Password to log into your secondary AdGuard instance. Only necessary if credentials are different between primary and secondary Value of 'ADGUARD_PASS'
REFRESH_INTERVAL_SECS No Frequency in seconds to refresh entries. 60
SYNC_ENTRIES No If 'true', will sync rewrite entries. true
SYNC_BLOCKED_SERVICES No If 'true', will sync blocked services. true
SYNC_BLOCK_ALLOW_LISTS No If 'true', will sync block/allow lists. true
SYNC_CUSTOM_RULES No If 'true', will sync custom rules. true

Once you've updated the file and ensure you have docker and docker-compose installed, run the following in the root directory:

docker-compose up -d

You can check on the status of your newly running pod with:

docker-compose logs

NOTE: The container is set to automatically restart when the docker daemon restarts.