lovelaze/nebula-sync
1
0
Fork 0
mirror of https://github.com/lovelaze/nebula-sync.git synced 2025-11-05 18:29:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: update README

Browse Source
This commit is contained in:
Fredrik Berntsson
2025-03-28 13:27:07 +01:00
committed by lovelaze
parent bd295734d2
commit 1cafe2fd5d
1 changed files with 24 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+24
View File
@@ -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.