gravity-sync/gravity-sync.conf.example
Michael Stanclift 836a5a1611
3.2.0 (#127)
* Add configuration variables for DNSMASQ files and directories

* Move compare function to gs-core

* Words

* Add validation command for DNSMASQ

* conditional checking of cname folder

* Add CNAME file to md5 check

* Reanalyse CNAME

* Bug report #125

* Add varilable for GS conf file

* more syncing

* Version 3.2

* Add DNS folder validation to other tasks

* Backup CNAME files

* {}

* Add message if no local files are detected but selected for backup

* Add CNAME list to restore code

* Pull CNAME, validate permissions

* Add pull function to runtime

* Extra R

* Use new permission validation function

* Push CNAME function added

* Missing variable name

* Add MD5 logging for CNAME files

* Add CNAME to smart task

* Change location of remote DNSMASQ file backups

* 1 not 0

* Change backup folder location

* Remove {}?

* “”

* INCLUDE_CNAME

* Detect invalid CNAME configuration

* Explainers for CNAME enabling

Co-authored-by: Michael Stanclift <vmstan@sovereign.local>
2021-01-04 14:37:35 -06:00

59 lines
2.5 KiB
Plaintext

# REQUIRED SETTINGS ######################
# Primary Pi-hole host (in IP or DNS name)
REMOTE_HOST='192.168.1.10'
# User account on primary with SUDO rights
REMOTE_USER='pi'
# STANDARD VARIABLES #########################
### Installation Types
# PH_IN_TYPE='' # Pi-hole install type, `default` or `docker` (local)
# RH_IN_TYPE='' # Pi-hole install type, `default` or `docker` (remote)
### Pi-hole Folder/File Customization
# PIHOLE_DIR='' # default Pi-hole data directory (local)
# RIHOLE_DIR='' # default Pi-hole data directory (remote)
# DNSMAQ_DIR='' # default DNSMASQ data directory (local)
# RNSMAQ_DIR='' # default DNSMASQ data directory (remote)
# PIHOLE_BIN='' # default Pi-hole binary directory (local)
# RIHOLE_BIN='' # default Pi-hole binary directory (remote)
# DOCKER_BIN='' # default Docker binary directory (local)
# ROCKER_BIN='' # default Docker binary directory (remote)
# FILE_OWNER='' # default Pi-hole file owner and group (local)
# RILE_OWNER='' # default Pi-hole file owner and group (remote)
# DOCKER_CON='' # default Pi-hole Docker container name (local)
# ROCKER_CON='' # default Pi-hole Docker container name (remote)
# GRAVITY_FI='' # default Pi-hole database file
# CUSTOM_DNS='' # default Pi-hole local DNS lookups
# CNAME_CONF='' # default DNSMASQ CNAME alias file
# GSLAN_CONF='' # default DNSMASQ GS managed file
### Interaction Customization
# VERIFY_PASS='' # replace in gravity-sync.conf to overwrite
# SKIP_CUSTOM='' # replace in gravity-sync.conf to overwrite
# INCLUDE_CNAME='' # replace in gravity-sync.conf to overwrite
# DATE_OUTPUT='' # replace in gravity-sync.conf to overwrite
# PING_AVOID='' # replace in gravity-sync.conf to overwrite
# ROOT_CHECK_AVOID='' # replace in gravity-sync.conf to overwrite
### Backup Customization
# BACKUP_RETAIN='' # replace in gravity-sync.conf to overwrite
### SSH Customization
# SSH_PORT='' # default SSH port
# SSH_PKIF='' # default local SSH key
### GS Folder/File Locations
# CONFIG_FILE='' # must exist with primary host/user configured
# GS_FILENAME='' # must exist because it's this script
# BACKUP_FOLD='' # must exist as subdirectory in LOCAL_FOLDR
# LOG_PATH='' # replace in gravity-sync.conf to overwrite
# SYNCING_LOG='' # replace in gravity-sync.conf to overwrite
# CRONJOB_LOG='' # replace in gravity-sync.conf to overwrite
# HISTORY_MD5='' # replace in gravity-sync.conf to overwrite
### OS Settings
# BASH_PATH='' # default OS bash path