adguard-sync

KO | EN

gitlite — search

#javascript #hacktoberfest #typescript #rust #linux #nodejs #windows #awesome #kubernetes #awesome-list #vue #mcp #openai #ios

(★ 44)

Sync tool for local Adguard Home DNS instances

adguard-sync Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# AdGuard Sync

![Docker](https://github.com/atoy3731/adguard-sync/workflows/Docker/badge.svg)

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. It is highly advisable to use IP over hostnames to avoid DNS issues. (ie. http://192.168.1.2) | N/A |
| ADGUARD_SECONDARY | Yes | Secondary base URL for the primary AdGuard instance It is highly advisable to use IP over hostnames to avoid DNS issues. (ie. http://192.168.1.3) | 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 |
| SYNC_GENERAL_SETTINGS | No | If 'true', will sync general settings. | true |
| SYNC_DNS_SETTINGS | No | If 'true', will sync DNS settings. | true |
| SYNC_ENCRYPTION_SETTINGS | No | If 'true', will sync encrypt settings. | false |

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

```bash
docker-compose up -d
```

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

```bash
docker-compose logs
```

If you'd prefer to utilize Docker without docker-compose, you can use the following command (substituting your values and adding any necessary environment variables):

```bash
docker run -d --name adguard-sync --restart=always \
    -e "ADGUARD_PRIMARY=http://192.168.1.2" \
    -e "ADGUARD_SECONDARY=http://192.168.1.3" \
    -e "ADGUARD_USER=admin" \
    -e "ADGUARD_PASS=password" \
    atoy3731/adguard-sync:2.1
```

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

### Encryption Syncing with Certifications/Keys

If you plan to sync encryption settings across environments and you're using paths for certificates/keys, you *must make sure the files exist in both primary and secondary AdGuard instances*! Given this, `SYNC_ENCRYPTION_SETTINGS` is defaulted to `false` as a safety measure.

### Known Issues

#### Permission Error Running on Raspbian

When running on older versions of Raspbian, you may run into permission issues and see errors like the following in your logs:
```
Fatal Python error: pyinit_main: can't initialize time
Python runtime state: core initialized
PermissionError: [Errno 1] Operation not permitted
```

For this, you'll need to update to a newer version of `libseccomp2`:
```
wget http://ftp.us.debian.org/debian/pool/main/libs/libseccomp/libseccomp2_2.5.1-1_armhf.deb
sudo dpkg -i libseccomp2_2.5.1-1_armhf.deb
```

adguard-sync

adguard-sync Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

adguard-sync

adguard-sync Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README