Mirrored_Repos/gravity-sync
1
0
Fork 0
mirror of https://github.com/vmstan/gravity-sync.git synced 2024-08-30 18:22:11 +00:00
Code Issues Packages Projects Releases Wiki Activity
739 Commits 2 Branches 86 Tags 1.6 MiB
Shell 99.8%
Dockerfile 0.2%
97735f19f1
Go to file
Michael Stanclift 97735f19f1
3.3.0 (#161) 
* Catch up 3.3 (#142)

* 3.2.5 (#140)

Co-authored-by: Michael Stanclift <vmstan@mstanclift-a03.vmware.com>

* Adds backup cleanup back to process

* Add backup cleanup to compare script when no changes are detected.

* Trek reference

* Redundant

* 3.2.6

* 3.2.6

Co-authored-by: Michael Stanclift <vmstan@mstanclift-a03.vmware.com>
Co-authored-by: Michael Stanclift <vmstan@mstanclift-a03.local>

* Beginning 3.3.0 work

* Podman support

* Support for pihole running in a podman container (#138)

* add support for pihole running in a podman container

* revert renaming of DOCKER_CON to CON_NAME to avoid breaking existing installations

Co-authored-by: Michael Stanclift <mstanclift@vmware.com>

* Add sudo to call of Pihole container version

* Use dev branch pipe

* Without origin

* ascii

* rotate logo

* Move config files to settings folder

* MIssed an important one

* Relocate logs files

* Filling empty directory

* Regression of sudo fix

* Logs

* More words

* Change sync frequency options

* Remove backup automation

* Bold questions

* name

* elif

* BACKUP_RETAIN=3

* Remove automation flag

* == not !=

* Rearrange

* IF

* Default to 0

* 15 default

* More words!

* ELSE

* tighter columns

* Instance type

* Y/N

Co-authored-by: Michael Stanclift <vmstan@mstanclift-a03.vmware.com>
Co-authored-by: Michael Stanclift <vmstan@mstanclift-a03.local>
Co-authored-by: Martin F. Schumann <mfs@mfs.name>
2021-02-09 16:05:17 -06:00
.github/ISSUE_TEMPLATE Update bug_report.md 2021-02-05 22:24:20 -06:00
backup Make logging path user adjustable 2020-05-27 10:00:30 -05:00
docs 3.2.1 (#129) 2021-01-05 09:57:38 -06:00
includes 3.3.0 (#161) 2021-02-09 16:05:17 -06:00
logs 3.3.0 (#161) 2021-02-09 16:05:17 -06:00
prep 3.3.0 (#161) 2021-02-09 16:05:17 -06:00
settings 3.3.0 (#161) 2021-02-09 16:05:17 -06:00
templates 3.0.0 (#100) 2020-10-07 17:45:39 -05:00
.gitignore 3.3.0 (#161) 2021-02-09 16:05:17 -06:00
CHANGELOG.md 3.3.0 (#161) 2021-02-09 16:05:17 -06:00
gravity-sync.sh 3.3.0 (#161) 2021-02-09 16:05:17 -06:00
LICENSE Initial commit 2020-05-21 12:57:19 -05:00
README.md Update README.md 2021-01-12 14:18:42 -06:00
VERSION 3.3.0 (#161) 2021-02-09 16:05:17 -06:00

README.md

Gravity Sync

What is better than a Pi-hole blocking ads via DNS on your network? That's right, two Pi-hole blocking ads on your network!

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 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.

Gravity Sync can also (optionally) replicate FTLDNS/DNSMASQ configuration files, including:

  • Local DNS (A Records) which are stored in a separate custom.list file within the /etc/pihole directory.
  • CNAME Records which are stored in a separate 05-pihole-custom-cname.conf file in the /etc/dnsmasq.d directory.

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
  2. Prepare Your Pi-hole
  3. Install Gravity Sync (or Upgrade)
  4. Configure Gravity Sync
  5. Execute Gravity Sync
  6. Automate Gravity Sync
  7. Profit

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 of Pi-hole LLC.

Additional Documentation

Please refer to the Wiki for more information: