diff --git a/CHANGELOG.md b/CHANGELOG.md index ecb8ea6..8445d7a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,11 +1,10 @@ -#Changelog +# The Changelog ## 1.7 - **Features** -- Gravity Sync will now manage the custom.list file that contains the "Local DNS Records" function within the Pi-hole interface. -- If you do not want this feature enabled it can be bypassed by adding a SKIP_CUSTOM='1' to your .conf file. +- Gravity Sync will now manage the `custom.list` file that contains the "Local DNS Records" function within the Pi-hole interface. +- If you do not want this feature enabled it can be bypassed by adding a `SKIP_CUSTOM='1'` to your .conf file. - Sync will be trigged during a pull operation if there are changes to either file. **Known Issues** @@ -13,53 +12,114 @@ - No new Star Trek references. ## 1.6 - **Features** -- New ./gravity-sync restore function will bring a previous version of the gravity.db back from the dead. +- New `./gravity-sync restore` function will bring a previous version of the `gravity.db` back from the dead. - Changes way that GS prompts for data input and how confirmation prompts are handled. -- Adds ability to override verification of push, restore or config reset, see .example file for details. +- Adds ability to override verification of push, restore or config reset, see `.example` file for details. - Five new Star Trek references. **Bug Fixes** - New functions add consistency in status output. ## 1.5 +**Features** -## 1.4 +- You can now easily deploy the task automation via crontab by running `./gravity-sync.sh automate` which will simply ask how often you'd like to run the script per hour, and then create the entry for you. +- If you've already configured an entry for this manually with a prior version, the script should detect this and ask that you manually remove it or edit it via crontab -e. I'm hesitant to delete existing entries here, as it could potentially remove something unrelated to Gravity Sync. + +**Bug Fixes** + +- Changes method for pulling development branch updates via the beta function. +- Cleanup of various exit commands. + +## 1.4 +**Features** +- Adds new `./gravity-sync config` feature to simplify deployment! +- Adds variables for SSH settings. +- Rearranges functions, which impacts nothing. +- All new and exciting code comments. +- No new Star Trek references. -### 1.4.3 -### 1.4.2 ### 1.4.1 +- Adds variables for custom log locations to `gravity-sync.conf`, see `.example` file for listing. +### 1.4.2 +- Will prompt to create new `gravity-sync.conf` file when run without an existing configuration. +### 1.4.3 +- Bug fixes around not properly utilizing custom SSH keyfile. ## 1.3 +1.3 should be called 2.0, but I'll resist that temptation -- so many new enhancements! + +**Features** +- GS will now compare remote and local databases and only replicate if it detects a difference. +- Verifies most commands complete before continuing each step to fail more gracefully. +- Additional debugging options such as checking last cronjob output, if configured. +- Much more consistency in how running commands are processed in interactive mode. +- What was once a 10 line bash script is now a 500 line monster (good, bad?) ### 1.3.4 -### 1.3.3 -### 1.3.2 +- Moves backup of local database before initiating remote pull. +- Validates file ownership and permissions before attempting to rewrite. +- Added two Star Trek references. + ### 1.3.1 +- Changes [GOOD] to [DONE] in execution output. +- Better validation of initial SSH connection. +- Support for password based authentication using SSHPASS. + +### 1.3.2 +- MUCH cleaner output, same great features. + +### 1.3.3 +- Corrected Pihole bin path issue that cause automated sync not to reload services. ## 1.2 +- Refactored process to use functions and cleanup process of execution. +- Does not look for permission to update when run. +- Cleanup and expand comments. + +### 1.2.1 +- Improved logging functions. + +### 1.2.2 +- Different style for status updates. + +### 1.2.3 +- Uses a dedicated backup folder for `.backup` and `.last` files. +- Copies db instead of moving to rename and then replacing to be more reliable. +- Even cleaner label status. + +### 1.2.4 +- Changes `~` to `$HOME`. +- Fixes bug that prevented sync from working when run via crontab. ### 1.2.5 -### 1.2.4 -### 1.2.3 -### 1.2.2 -### 1.2.1 +- Push function now does a backup, on the secondary PH, of the primary database, before pushing. ## 1.1 +- Seperated main purpose of script into `pull` argument. +- Allow process to reverse back using `push` argument. -Moved from Gist. +### 1.1.2 +- First release since move from being just a Gist. +- Just relearning how to use GitHub, minor bug fixes. + +### 1.1.3 +- Now includes example an configuration file. + +### 1.1.4 +- Added update script. +- Added version check. + +### 1.1.5 +- Added ability to view logs with `./gravity-sync.sh logs`. ### 1.1.6 -### 1.1.5 -### 1.1.4 -### 1.1.3 -### 1.1.2 +- Code easier to read with proper tabs. ## 1.0 - -Initial release, to Andrew, internal Slack and eventually [vmstan.com](https://vmstan.com/gravity-sync) +Initial release: to Andrew, internal Slack and eventually [vmstan.com](https://vmstan.com/gravity-sync). ``` echo 'Copying gravity.db from HA primary'