Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/WillFantom/agh-updater
Sync AdGuard Home TLS certs with Træfik generated certs
https://github.com/WillFantom/agh-updater
Last synced: about 2 months ago
JSON representation
Sync AdGuard Home TLS certs with Træfik generated certs
- Host: GitHub
- URL: https://github.com/WillFantom/agh-updater
- Owner: WillFantom
- License: gpl-3.0
- Created: 2022-05-07T08:11:38.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-05-08T17:43:39.000Z (over 2 years ago)
- Last Synced: 2024-04-23T13:36:47.141Z (5 months ago)
- Language: Shell
- Size: 20.5 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AdGuard Home Settings Updater
This script can manage your AdGuard Home settings at regular intervals:
- Keep your block/allow lists updated, executing the list refresh on each run
- Sync your TLS cert settings with Træfik
---
## AdGuard Home + Træfik
Always ensure your AdGuard Home TLS settings are in sync with your Træfik generated certs!
---
If you use [AdGuard Home](https://github.com/AdguardTeam/AdGuardHome) for DoH/DoQ/DoT, and you use Træfik Proxy + Lets Encrypt to automatically generate certs for your AdGuard domain, you will know that it can be annoying when your certs expire and you have to go diving in your Træfik certs file to find and decode your cert and key for AdGuard... It's a whole 2-minute task every few months!! If you just can't deal with that pain, this is for you 🫵
## Usage [with docker 🐳]
Simply run the container with your credentials and paths set up:
```bash
docker run --rm -d --name agh-updater -v /services/traefik/certs:/traefikcerts:ro \
-e ADGUARD_USERNAME=exampleuser -e ADGUARD_PASSWORD=asecret \
-e ADGUARD_DOMAIN=adguard.example.com -e TRAEFIK_CERT_JSON=/traefikcerts/acme.json \
ghcr.io/willfantom/agh-updater:latest
```
## Usage [with docker compose 🐳]
See the example setup [here](/example/docker-compose.yml)!
## Usage [bash]
```bash
./agh-updater.sh -u exampleuser -p asecret \
-d adguard.example.com -f /services/traefik/certs/acme.json
```
## Configuration
| ENV Variable | CLI Parameter | Description | Default | Required |
| :----------------------------------------: | :-----------: | :----------------------------------------------------------: | :----------------: | :------: |
| `ADGUARD_USERNAME` | `-u <>` | Your AdGuard Home admin username for API access | N/A | ✅ |
| `ADGUARD_PASSWORD` | `-p <>` | Your AdGuard Home admin password for API access | N/A | ✅ |
| `ADGUARD_DOMAIN` | `-d <>` | Your AdGuard Home domain (without scheme or port) | N/A | ✅ |
| `TRAEFIK_CERT_JSON` | `-f <>` | Path to your Træfik cert storage file | N/A | ✅ |
| `INTERVAL`
(Docker only) | `-i <>` | ReUpdate the certs every X seconds (`0` if do only once) | 0 (`60` in Docker) | ❌ |
| | `-e` | Exit update loop if an error is encountered | not-set | ❌ |
| `ADGUARD_API_SCHEME` | | Scheme to use to access your AdGuard instance API | `https` | ❌ |
| `ADGUARD_API_PORT` | | Port to access your AdGuard instance API | `443` | ❌ |
| | `-h` | Print CLI Help | | ❌ |
| `TRAEFIK_CERT_RESOLVER`
(Docker only) | | Name of the certificate resolver used for the adguard domain | `[]` (any) | ❌ |