mirror of
https://github.com/vmstan/gravity-sync.git
synced 2024-08-30 18:22:11 +00:00
d97f92ccea
* new first line of script * no requested * Abort! * Test silent folder validation * sameline * echo newline * echo_sameline * what happened? * sameline for ssh * sqlite sameline * Lower case * Reset line * clear line * Flip the line * version update * Backup lowercase * More lowercase * Remove file names from standard messages * Breakout backup message * Output backup folder size * Just H * Invalid replication settings * Compare updated * Colors and updates * Lower case for version output * For Pihole * Cron cleanup * Sudo, or no sudo. * Branch! * Silent error validate * Silent error validate * Clearing up status messages * Records * Primary and secondary * Gravity database * Domain Database * Backup output cleanup * Move file permission validation into new functions * Change restart * UI variables test * Breakout UI variables into new file * Unified validation functions * Replace text strings with variables * Replace text strings with variables * Replace logging with variables * Convert backup to UI variables * Switch restore to UI variables * Fix bug where gravity database did not restore * App validation checks * Rev to 3.4.0 * Convert Push functions to new strings * Completing push UI changes * remove added line * Move purge to UI strings * Move automation to UI strings * Move core strings into UI * Exit strings * First pass at hashing UI * Escape the remote system query (#179) * hashing committed Co-authored-by: Michael Stanclift <vmstan@mstanclift-a03.local> Co-authored-by: Veduco <59983694+Veduco@users.noreply.github.com>
61 lines
3.4 KiB
Markdown
61 lines
3.4 KiB
Markdown
<p align="center">
|
|
<img src="https://vmstan.com/content/images/2021/02/gs-logo.svg" width="300" alt="Gravity Sync">
|
|
</p>
|
|
|
|
<span align="center">
|
|
|
|
# Gravity Sync
|
|
|
|
</span>
|
|
|
|
###
|
|
|
|
What is better than a [Pi-hole](https://github.com/pi-hole/pi-hole) blocking trackers, advertisements, and other malicious domains on your network? That's right, **two** Pi-hole blocking all that junk 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 where Gravity Sync comes in. With proper preparation, it should only take a few minutes to install. Ideally you setup 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 replicates the Pi-hole Domain Database (`gravity.db`), 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.
|
|
|
|
Gravity Sync can also (optionally) replicate the Local DNS Records and CNAMEs configuration files.
|
|
|
|
### Limitations
|
|
|
|
Gravity Sync will **not**:
|
|
|
|
- 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.
|
|
|
|
## 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)
|
|
3. [Install Gravity Sync](https://github.com/vmstan/gravity-sync/wiki/Installing#secondary-pi-hole) (or [Upgrade](https://github.com/vmstan/gravity-sync/wiki/Updating))
|
|
4. [Configure Gravity Sync](https://github.com/vmstan/gravity-sync/wiki/Installing#configuration)
|
|
5. [Execute Gravity Sync](https://github.com/vmstan/gravity-sync/wiki/Installing#execution)
|
|
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:
|
|
|
|
- [Frequently Asked Questions](https://github.com/vmstan/gravity-sync/wiki/Frequent-Questions)
|
|
- [Advanced Installation Options](https://github.com/vmstan/gravity-sync/wiki/Under-The-Covers)
|
|
- [Changelog](https://github.com/vmstan/gravity-sync/wiki/Changelog) |