Skip to content

Adding notes to README for password-less configuration #142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
joewesch wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Adding notes to README for password-less configuration #142

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4f0d847
Adds notes for password-less configuration
joewesch May 8, 2025
e34a7b4
Consolidates docker-compose examples into single file
joewesch May 22, 2025
b4b83b8
Consolidates env examples into single file
joewesch May 22, 2025
df26ca4
Updates README
joewesch May 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ services:
environment:
- PRIMARY=http://ph1.example.com|password
- REPLICAS=http://ph2.example.com|password,http://ph3.example.com|password
# If your Pi-hole instances are not using a password, you still need to include | but leave the password empty
# e.g. - PRIMARY=http://ph1.example.com|
# - REPLICAS=http://ph2.example.com|,http://ph3.example.com|
- FULL_SYNC=true
- RUN_GRAVITY=true
- CRON=0 * * * *
Expand Down Expand Up @@ -75,6 +78,8 @@ The following environment variables can be specified:
| `REPLICAS`| n/a | `http://ph2.example.com\|password,http://ph3.example.com\|password` | Specifies the list of replica Pi-hole configurations |
| `FULL_SYNC` | n/a | `true` | Specifies whether to perform a full synchronization |

> **Note:** If your Pi-hole instances are not using a password, you still need to include `|` but leave the password empty. e.g. `http://ph1.example.com|`

> **Note:** When `FULL_SYNC=true`, the system will perform a full Teleporter import/export from the primary Pi-hole to the replicas. This will synchronize all settings and configurations.

> **Docker secrets:** `PRIMARY` and `REPLICAS` environment variables support Docker secrets when defined as `PRIMARY_FILE` and `REPLICAS_FILE`. See note regarding default user and Docker secrets example below.
Expand Down