From e4d2712a984bd018fe941dac5f0976ee1e7a3882 Mon Sep 17 00:00:00 2001 From: Michael Stanclift Date: Wed, 21 Oct 2020 16:04:44 -0500 Subject: [PATCH] Created Updating (markdown) --- Updating.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 Updating.md diff --git a/Updating.md b/Updating.md new file mode 100644 index 0000000..a30f53f --- /dev/null +++ b/Updating.md @@ -0,0 +1,19 @@ +If you'd like to know what version of the script you have running, run the built in version checker. It will notify you if there are updates available. + +```bash +./gravity-sync.sh version +``` + +You can then run the built-in updater to get the latest version of all the files. Both the `version` and `update` commands reach out to GitHub, so outbound access to GitHub.com is required. + +```bash +./gravity-sync.sh update +``` + +Your copy of the `gravity-sync.conf` file, logs and backups should not be be impacted by this update, as they are specifically ignored. The main goal of Gravity Sync is to be simple to execute and maintain, so any additional requirements should also be called out when it's executed. + +After updating, be sure to manually run a `./gravity-sync.sh compare` to validate things are still working as expected. + +You can run a `./gravity-sync.sh config` at any time to generate a new configuration file if you're concerned that you're missing something, especially after a major version upgrade. + +- If the update script fails, make sure you did your original deployment via the online installation script or with `git clone` -- and not a manual install. Refer to [Updater Issues](https://github.com/vmstan/gravity-sync/wiki/Troubleshooting#updater-issues) or [Manual Updates](https://github.com/vmstan/gravity-sync/wiki/Under-The-Covers#manual-updates) for more details. \ No newline at end of file