diff --git a/README.md b/README.md index 6a38b4a..ca84766 100644 --- a/README.md +++ b/README.md @@ -2,35 +2,32 @@ Gravity Sync

-What is better than a [Pi-hole](https://github.com/pi-hole/pi-hole) blocking ads via DNS on your network? That's right, two Pi-hole blocking ads on your network! +What is better than a [Pi-hole](https://github.com/pi-hole/pi-hole) blocking ads via DNS on your network? That's right, **two** Pi-hole blocking ads on your network! + +- [Seriously. Why two Pi-hole?](https://github.com/vmstan/gravity-sync/wiki/Frequent-Questions#why-do-i-need-more-than-one-pi-hole) But if you have more than one Pi-hole in your network you'll want a simple way to keep the list configurations and local DNS settings identical between the two. That's Gravity Sync. With proper preparation it should only take a few minutes to install. Ideally you set up Gravity Sync and forget about it -- and in the long term, it would be awesome if the Pi-hole team made this entire script unnecessary. -## Features - -Gravity Sync the `gravity.db` database which includes: +# Features +Gravity Sync replicates the `gravity.db` database, which includes: - Blocklist settings with status and comments. - Domain whitelist and blacklist along with status with comments. - Custom RegEx whitelist and blacklists. - Clients and groups along with any list assignments. -- The Local DNS Settings feature in Pi-hole (These are stored in a separate `custom.list` file and this can optionally be disabled.) +- Local DNS Settings (These are stored in a separate `custom.list` file and can optionally be disabled.) ### Limitations Gravity Sync will **not**: -- Overwrite or sync device specific Pi-hole settings such as the local network configuration. -- Overwrite or sync the Pi-hole admin/API passwords, nor does not leverage these at all. -- Overwrite or sync the upstream DNS resolvers, etc. -- Overwrite or sync DHCP settings or device leases synchronized. -- Overwrite or sync long term data, query logs, or statistics. +- Overwrite device specific Pi-hole settings specific to the local network configuration. +- Change the Pi-hole admin/API passwords, nor does not leverage these at all. +- Modify the individual Pi-hole's upstream DNS resolvers. +- Sync DHCP settings or monitor device leases. +- Merge long term data, query logs, or statistics. -### Disclaimer - -Gravity Sync is not developed by or affiliated with the Pi-hole project. This is an effort that seeks to implement replication, which is currently not a part of the core Pi-hole product. The code has been tested across multiple user environments but there always is an element of risk involved with running any arbitrary software you find on the Internet. - -## Setup Steps +# Setup Steps 1. [Review System Requirements](https://github.com/vmstan/gravity-sync/wiki/System-Requirements) 2. [Prepare Your Pi-hole](https://github.com/vmstan/gravity-sync/wiki/Installing#primary-pi-hole) @@ -40,6 +37,12 @@ Gravity Sync is not developed by or affiliated with the Pi-hole project. This is 6. [Automate Gravity Sync](https://github.com/vmstan/gravity-sync/wiki/Installing#automation) 7. [Profit](https://memory-alpha.fandom.com/wiki/Rules_of_Acquisition) +# Disclaimer + +Gravity Sync is not developed by or affiliated with the Pi-hole project. This is project an unofficial, community effort, that seeks to implement replication (which is currently not a part of the core Pi-hole product) in a way that provides stability and value to Pi-hole users. The code has been tested across multiple user environments but there always is an element of risk involved with running any arbitrary software you find on the Internet. + +Pi-hole is and the Pi-hole logo are [registered trademarks](https://pi-hole.net/trademark-rules-and-brand-guidelines/) of Pi-hole LLC. + # Additional Documentation Please refer to the [Wiki](https://github.com/vmstan/gravity-sync/wiki) for more information: