atoy3731/adguard-sync
1
1
Fork 0
mirror of https://github.com/atoy3731/adguard-sync.git synced 2024-11-10 09:12:48 +08:00
Code Issues Projects Releases Packages Wiki Activity
Sync tool for local Adguard Home DNS instances
11 commits 4 branches 4 tags 83 KiB
Python 98.7%
Dockerfile 1.3%
Find a file
Adam Toy 3e689d2406 location
2021-01-31 13:08:31 -05:00
.github/workflows Fix 2021-01-31 12:56:25 -05:00
src Add unbuffed env for python stdout 2021-01-31 13:06:23 -05:00
.gitignore first commit 2021-01-31 12:46:48 -05:00
docker-compose.yaml first commit 2021-01-31 12:46:48 -05:00
Dockerfile Add unbuffed env for python stdout 2021-01-31 13:04:55 -05:00
LICENSE Create LICENSE 2021-01-31 12:51:28 -05:00
README.md location 2021-01-31 13:08:31 -05:00
requirements.txt Directory updates 2021-01-31 12:54:33 -05:00
VERSION first commit 2021-01-31 12:46:48 -05:00

README.md

AdGuard Sync

Docker

This project will sync entries between two Primary and Secondary AdGuard Home instances 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. 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_PASSWORD'
REFRESH_INTERVAL_SECS No Frequency in seconds to refresh entries. 60

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

It's highly advisable to run this on the same instance that is running your Primary instance.

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.