From 1cafe2fd5daf44891d98e60b203f2b4fc41cdd90 Mon Sep 17 00:00:00 2001 From: Fredrik Berntsson Date: Fri, 28 Mar 2025 13:27:07 +0100 Subject: [PATCH] docs: update README --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index bb5bf55..06d4c24 100644 --- a/README.md +++ b/README.md @@ -109,6 +109,30 @@ The following environment variables can be specified: | `SYNC_GRAVITY_CLIENT_BY_GROUP` | false | Synchronize clients by group | +#### Config filters +> Allows including or excluding specific config keys.\ +**Note:** `The SYNC_CONFIG_*_INCLUDE` and `SYNC_CONFIG_*_EXCLUDE` settings are mutually exclusive within each section.\ +Config keys are relative to the section and are **case sensitive**. For example, the key `dns.upstreams` should be referred to as `upstreams`, and `dns.cache.size` should be referred to as `cache.size`. + +| Name | Example | Description | +|-----------------------------------|----------------------------|-------------------------------------------------| +| `SYNC_CONFIG_DNS_INCLUDE` | upstreams,interface | DNS config keys to include | +| `SYNC_CONFIG_DNS_EXCLUDE` | upstreams,interface | DNS config keys to exclude | +| `SYNC_CONFIG_DHCP_INCLUDE` | active,start | DHCP config keys to include | +| `SYNC_CONFIG_DHCP_EXCLUDE` | active,start | DHCP config keys to exclude | +| `SYNC_CONFIG_NTP_INCLUDE` | ipv4,sync | NTP config keys to include | +| `SYNC_CONFIG_NTP_EXCLUDE` | ipv4,sync | NTP config keys to exclude | +| `SYNC_CONFIG_RESOLVER_INCLUDE` | resolveIPv4,networkNames | Resolver config keys to include | +| `SYNC_CONFIG_RESOLVER_EXCLUDE` | resolveIPv4,networkNames | Resolver config keys to exclude | +| `SYNC_CONFIG_DATABASE_INCLUDE` | DBimport,maxDBdays | Database config keys to include | +| `SYNC_CONFIG_DATABASE_EXCLUDE` | DBimport,maxDBdays | Database config keys to exclude | +| `SYNC_CONFIG_MISC_INCLUDE` | nice,delay_startup | Misc config keys to include | +| `SYNC_CONFIG_MISC_EXCLUDE` | nice,delay_startup | Misc config keys to exclude | +| `SYNC_CONFIG_DEBUG_INCLUDE` | database,networking | Debug config keys to include | +| `SYNC_CONFIG_DEBUG_EXCLUDE` | database,networking | Debug config keys to exclude | + + + ## Disclaimer This project is an unofficial, community-maintained project and is not affiliated with the [official Pi-hole project](https://github.com/pi-hole). It aims to add sync/replication features not available in the core Pi-hole product but operates independently of Pi-hole LLC. Although tested across various environments, using any software from the Internet involves inherent risks. See the [license](https://github.com/lovelaze/nebula-sync/blob/main/LICENSE) for more details.