Merge branch 'deajan:master' into kerberos-patch

gruoner · web-flow · commit c5ef7a916e38 · 2025-01-19T14:11:29.000+01:00
diff --git a/README.md b/README.md
@@ -8,22 +8,22 @@
 [![macos tests](https://github.com/deajan/osync/actions/workflows/macos.yml/badge.svg)](https://github.com/deajan/osync/actions/workflows/macos.yml/badge.svg)
 
 
-A two way filesync script running on bash Linux, BSD, Android, MacOSX, Cygwin, MSYS2, Win10 bash  and virtually any system supporting bash).
-File synchronization is bidirectional, and can be run manually, as scheduled task, or triggered on file changes in daemon mode.
+A two way filesync script running on bash Linux, BSD, Android, MacOSX, Cygwin, MSYS2, Win10 bash and virtually any system supporting bash.
+File synchronization is bidirectional, and can be run manually, as scheduled task, or triggered on file changes in monitor mode.
 It is a command line tool rsync wrapper with a lot of additional features baked in.
 
-This is a quickstart guide, you can find the full documentation on the author's site.
+This is a quickstart guide, you can find the full documentation on the [author's site](http://www.netpower.fr/osync).
 
 ## About
 
-osync provides the following capabilities
+osync provides the following capabilities:
 
 -   Local-Local and Local-Remote sync
 -   Fault tolerance with resume scenarios
 -   POSIX ACL and extended attributes synchronization
 -   Full script Time control
 -   Soft deletions and multiple backups handling
--   Before / after run command execution
+-   Before/after run command execution
 -   Email alerts
 -   Logging facility
 -   Directory monitoring
@@ -33,33 +33,50 @@ osync provides the following capabilities
 osync is a stateful synchronizer. This means it's agentless and doesn't have to monitor files for changes. Instead, it compares replica file lists between two runs.
 A full run takes about 2 seconds on a local-local replication and about 7 seconds on a local-remote replication.
 Disabling some features file like attributes preservation and disk space checks may speed up execution. 
-osync uses a initiator / target sync schema. It can sync local to local or local to remote directories. By definition, initiator replica is always a local directory on the system osync runs on.
-osync uses pidlocks to prevent multiple concurrent sync processes on/to the same initiator / target replica.
+osync uses a initiator/target sync schema. It can sync local to local or local to remote directories. By definition, initiator replica is always a local directory on the system osync runs on.
+osync uses pidlocks to prevent multiple concurrent sync processes on/to the same initiator/target replica.
 You may launch concurrent sync processes on the same system but as long as the replicas to synchronize are different.
 Multiple osync tasks may be launched sequentially by osync osync-batch tool.
 
-Currently, it has been tested on CentOS 5.x, 6.x, 7.x, AlmaLinux 9, Fedora 22-25, Debian 6-11, Linux Mint 14-18, Ubuntu 12.04-22.04, FreeBSD 8.3-11, Mac OS X, QTS 4.5.1(x86) and pfSense 2.3.x.
-Microsoft Windows is supported via MSYS, Cygwin and or via WSL.
-Android support works via Termux.
-Some users also have successfully used osync on Gentoo and created an openRC init scriptt for it.
+## Tested platforms
+
+| Operating system | Version                |
+|------------------|------------------------|
+| AlmaLinux        | 9                      |
+| Android\*        | Not known              |
+| CentOS           | 5.x, 6.x, 7.x          |
+| Fedora           | 22-25                  |
+| FreeBSD          | 8.3-11                 |
+| Debian           | 6-11                   |
+| Linux Mint       | 14-18                  |
+| macOS            | Not known              |
+| pfSense          | 2.3.x                  |
+| QTS (x86)        | 4.5.1                  |
+| Ubuntu           | 12.04-22.04            |
+| Windows\*\*      | 10                     |
+
+\* via Termux.
+\*\* via MSYS, Cygwin and WSL.
+
+Some users also have successfully used osync on Gentoo and created an OpenRC init script for it.
 
 ## Installation
 
 osync has been designed to not delete any data, but rather make backups of conflictual files or soft deletes.
 Nevertheless, you should always have a neat backup of your data before trying a new sync tool.
 
-Getting osync via github (remove the -b "stable" if you want latest dev snapshot)
+Getting osync via GitHub (remove the -b "stable" if you want latest dev snapshot)
 
 	$ git clone -b "stable" https://github.com/deajan/osync
 	$ cd osync
 	$ bash install.sh
 
 Installer script accepts some parameters for automation. Launch install.sh --help for options.
 
-There is also a RPM file that should fit RHEL/CentOS/Fedora and basically any RPM based distro, see the github release.
-Please note that RPM files will install osync to /usr/bin instead of /usr/local/bin in order to enforce good practices.
+There is also an RPM file that should fit RHEL/CentOS/Fedora and basically any RPM based distro, see the GitHub release.
+Please note that RPM files will install osync to `/usr/bin` instead of `/usr/local/bin` in order to enforce good practices.
 
-osync will install itself to /usr/local/bin and an example configuration file will be installed to /etc/osync
+osync will install itself to `/usr/local/bin` and an example configuration file will be installed to `/etc/osync`.
 
 osync needs to run with bash shell. Using any other shell will most probably result in errors.
 If bash is not your default shell, you may invoke it using
@@ -70,7 +87,7 @@ On *BSD and BusyBox, be sure to have bash installed.
 
 If you can't install osync, you may just copy osync.sh where you needed and run it from there.
 
-Archlinux packages are available at <https://aur.archlinux.org/packages/osync/> (thanks to Shadowigor, <https://github.com/shadowigor>)
+Arch Linux packages are available at <https://aur.archlinux.org/packages/osync/> (thanks to Shadowigor, <https://github.com/shadowigor>).
 
 ## Upgrade from previous configuration files
 
@@ -86,99 +103,113 @@ The script will backup your config file, update it's content and try to connect
 
 ## Usage
 
-Osync can work with in three flavors: Quick sync mode, configuration file mode, and daemon mode.
-While quick sync mode is convenient to do fast syncs between some directories, a configuration file gives much more functionnality.
-Please use double quotes as path delimiters. Do not use escaped characters in path names.
+Osync can work in 3 modes:
+1. [:rocket: Quick sync mode](#quick-sync-mode)
+2. [:gear: Configuration file mode](#configuration-file-mode)
+3. [:mag_right: Monitor mode](#monitor-mode)
 
-## QuickSync example
+> [!NOTE]
+> Please use double quotes as path delimiters. Do not use escaped characters in path names.
+
+### <a id="quick-sync-mode"></a>:rocket: Quick sync mode
+
+Quick sync mode is convenient to do fast syncs between some directories. However, the [configuration file mode](#configuration-file-mode) gives much more functionality.
 
 	# osync.sh --initiator="/path/to/dir1" --target="/path/to/remote dir2"
 	# osync.sh --initiator="/path/to/another dir" --target="ssh://user@host.com:22//path/to/dir2" --rsakey=/home/user/.ssh/id_rsa_private_key_example.com
 
-## Summary mode
+#### Quick sync with minimal options
+
+In order to run osync the quickest (without transferring file attributes, without softdeletion, without prior space checks and without remote connectivity checks, you may use the following:
+
+	# MINIMUM_SPACE=0 PRESERVE_ACL=no PRESERVE_XATTR=no SOFT_DELETE_DAYS=0 CONFLICT_BACKUP_DAYS=0 REMOTE_HOST_PING=no osync.sh --initiator="/path/to/another dir" --target="ssh://user@host.com:22//path/to/dir2" --rsakey=/home/user/.ssh/id_rsa_private_key_example.com
+
+All the settings described here may also be configured in the conf file.
+
+### Summary mode
 
-osync may output only file changes and errors with the following
+osync will output only file changes and errors with the following:
 
 	# osync.sh --initiator="/path/to/dir1" --target="/path/to/dir" --summary --errors-only --no-prefix
 
 This also works in configuration file mode.
 
-## QuickSync with minimal options
+### <a id="configuration-file-mode"></a>:gear: Configuration file mode
 
-In order to run osync the quickest (without transferring file attributes, without softdeletion, without prior space checks and without remote connectivity checks, you may use the following:
-
-	# MINIMUM_SPACE=0 PRESERVE_ACL=no PRESERVE_XATTR=no SOFT_DELETE_DAYS=0 CONFLICT_BACKUP_DAYS=0 REMOTE_HOST_PING=no osync.sh --initiator="/path/to/another dir" --target="ssh://user@host.com:22//path/to/dir2" --rsakey=/home/user/.ssh/id_rsa_private_key_example.com
+You'll have to customize the `sync.conf` file according to your needs.
 
-All the settings described here may also be configured in the conf file.
+If you intend to sync a remote directory, osync will need a pair of private/public RSA keys to perform remote SSH connections. Also, running sync as superuser requires to configure the `/etc/sudoers` file.
 
-## Running osync with a Configuration file
+> [!TIP]
+> Read the [example configuration file](https://github.com/deajan/osync/blob/master/sync.conf.example) for documentation about remote sync setups.
 
-You'll have to customize the sync.conf file according to your needs.
-If you intend to sync a remote directory, osync will need a pair of private / public RSA keys to perform remote SSH connections.
-Also, running sync as superuser requires to configure /etc/sudoers file.
-Please read the documentation about remote sync setups.
-Once you've customized a sync.conf file, you may run osync with the following test run:
+Once you've customized a `sync.conf` file, you may run osync with the following test run:
 
 	# osync.sh /path/to/your.conf --dry
 
-If everything went well, you may run the actual configuration with one of the following:
+If everything went well, you may run the actual configuration with:
 
 	# osync.sh /path/to/your.conf
+
+To display which files and attrs are actually synchronized and which files are to be soft deleted / are in conflict, use `--verbose` (you may mix it with `--silent` to output verbose input only in the log files):
+ 
 	# osync.sh /path/to/your.conf --verbose
-	# osync.sh /path/to/your.conf --no-maxtime
 
-Verbose option will display which files and attrs are actually synchronized and which files are to be soft deleted / are in conflict.
-You may mix "--silent" and "--verbose" parameters to output verbose input only in the log files.
-No-Maxtime option will disable execution time checks, which is usefull for big initial sync tasks that might take long time. Next runs should then only propagate changes and take much less time.
+Use `--no-maxtime` to disable execution time checks, which is usefull for big initial sync tasks that might take long time. Next runs should then only propagate changes and take much less time:
+ 
+ 	# osync.sh /path/to/your.conf --no-maxtime
 
-Once you're confident about your first runs, you may add osync as a cron task like the following in /etc/crontab which would run osync every 30 minutes:
+Once you're confident about your first runs, you may add osync as a cron task like the following in `/etc/crontab` which would run osync every 30 minutes:
 
 	*/30 * * * * root /usr/local/bin/osync.sh /etc/osync/my_sync.conf --silent
 
-Please note that this syntax works for RedHat / CentOS. On Debian you might want to remove the username (ie root) in order to make the crontab entry work.
+Please note that this syntax works for RedHat/CentOS. On Debian you might want to remove the username (i.e. root) in order to make the crontab entry work.
 
-## Batch mode
+### Batch mode
 
-You may want to sequentially run multiple sync sets between the same servers. In that case, osync-batch.sh is a nice tool that will run every osync conf file, and, if a task fails,
+You may want to sequentially run multiple sync sets between the same servers. In that case, `osync-batch.sh` is a nice tool that will run every osync conf file, and, if a task fails,
 run it again if there's still some time left.
-The following example will run all .conf files found in /etc/osync, and retry 3 times every configuration that fails, if the whole sequential run took less than 2 hours.
+
+To run all `.conf` files found in `/etc/osync`, and retry 3 times every configuration that fails if the whole sequential run took less than 2 hours, use:
 
 	# osync-batch.sh --path=/etc/osync --max-retries=3 --max-exec-time=7200
 
 Having multiple conf files can then be run in a single cron command like
 
 	00 00 * * * root /usr/local/bin/osync-batch.sh --path=/etc/osync --silent
 
-## Daemon mode
+### <a id="monitor-mode"></a>:mag_right: Monitor mode
 
-Additionaly, you may run osync in monitor mode, which means it will perform a sync upon file operations on initiator replica.
-This can be a drawback on functionnality versus scheduled mode because this mode only launches a sync task if there are file modifications on the initiator replica, without being able to monitor the target replica.
-Target replica changes are only synced when initiator replica changes occur, or when a given amount of time (default 600 seconds) passed without any changes on initiator replica.
-File monitor mode can also be launched as a daemon with an init script. Please read the documentation for more info.
-Note that monitoring changes requires inotifywait command (inotify-tools package for most Linux distributions).
-BSD, MacOS X and Windows are not yet supported for this operation mode, unless you find a inotify-tools package on these OSes.
+> [!NOTE]
+> Monitoring changes requires inotifywait command (`inotify-tools` package for most Linux distributions). BSD, macOS and Windows are not yet supported for this operation mode, unless you find an `inotify-tool` package on these OSes.
 
-	# osync.sh /etc/osync/my_sync.conf --on-changes
+Monitor mode will perform a sync upon file operations on initiator replica. This can be a drawback on functionality versus scheduled mode because this mode only launches a sync task if there are file modifications on the initiator replica, without being able to monitor the target replica. Target replica changes are only synced when initiator replica changes occur, or when a given amount of time (600 seconds by default) passed without any changes on initiator replica.
+
+This mode can also be launched as a daemon with an init script. Please read the documentation for more info.
+
+To use this mode, use `--on-changes`:
 
-Osync file monitor mode may be run as system service with the osync-srv script.
-You may run the install.sh script which should work in most cases or copy the files by hand (osync.sh to /usr/bin/local, sync.conf to /etc/osync, osync-srv to /etc/init.d for initV, osync-srv@.service to /usr/lib/systemd/system for systemd, osync-srv-openrc to /etc/init.d/osync-srv-openrc for OpenRC).
+	# osync.sh /etc/osync/my_sync.conf --on-changes
 
-InitV specific instructions:
+To run this mode as a system service with the `osync-srv` script, you can run the `install.sh` script (which should work in most cases) or copy the files by hand:
+- `osync.sh` to `/usr/bin/local`
+- `sync.conf` to `/etc/osync`
+- For InitV, `osync-srv` to `/etc/init.d`
+- For systemd, `osync-srv@.service` to `/usr/lib/systemd/system`
+- For OpenRC, `osync-srv-openrc` to `/etc/init.d/osync-srv-openrc`
 
-	Any configuration file found in /etc/osync will create a osync daemon instance when service is launched on initV with:
+For InitV (any configuration file found in `/etc/osync` will create an osync daemon instance when service is launched on initV):
 
 	$ service osync-srv start
 	$ chkconfig osync-srv on
 
-Systemd specific (one service per config file)
+For systemd, launch service (one service per config file to launch) with:
 
-	Launch service (one service per config file to launch) with:
 	$ systemctl start osync-srv@configfile.conf
 	$ systemctl enable osync-srv@configfile.conf
 
-OpenRC specific instructions (user contrib)
+For OpenRC (user contrib), launch service (one service per config file to launch) with:
 
-	Launch service (one service per config file to launch) with:
 	$ rc-update add osync-srv.configfile default
 
 ## Security enhancements
@@ -190,21 +221,24 @@ Please read full documentation in order to configure ssh filter.
 
 All kind of contribs are welcome.
 
-When submitting a PR, please be sure to modify files in dev directory (dev/n_osync.sh, dev/ofunctions.sh, dev/common_install.sh etc) as most of the main files are generated via merge.sh.
+When submitting a PR, please be sure to modify files in dev directory (`dev/n_osync.sh`, `dev/ofunctions.sh`, `dev/common_install.sh etc`) as most of the main files are generated via merge.sh.
 When testing your contribs, generate files via merge.sh or use bootstrap.sh which generates a temporary version of n_osync.sh with all includes.
 
-Unit tests are run by travis on every PR, but you may also run them manually which adds some tests that travis can't do, via dev/tests/run_tests.sh
-SSH port can be changed on the fly via environment variable SSH_PORT, eg: SSH_PORT=2222 dev/tests/run_tests.sh
+Unit tests are run by travis on every PR, but you may also run them manually which adds some tests that travis can't do, via `dev/tests/run_tests.sh`.
+SSH port can be changed on the fly via environment variable SSH_PORT, e.g.:
+
+	# SSH_PORT=2222 dev/tests/run_tests.sh
 
 Consider reading CODING_CONVENTIONS.TXT before submitting a patch.
 
 ## Troubleshooting
 
-You may find osync's logs in `/var/log/osync.[INSTANCE_ID].log` (or current directory if /var/log is not writable).
+You may find osync's logs in `/var/log/osync.[INSTANCE_ID].log` (or current directory if `/var/log` is not writable).
 Additionnaly, you can use the --verbose flag see to what actions are going on.
 
-When opening an issue, please post the corresponding log files. Also, you may run osync with _DEBUG option in order to have more precise logs, eg:
-_DEBUG=yes ./osync.sh /path/to/conf
+When opening an issue, please post the corresponding log files. Also, you may run osync with _DEBUG option in order to have more precise logs, e.g.:
+
+	# _DEBUG=yes ./osync.sh /path/to/conf
 
 ## Uninstalling
 
@@ -214,5 +248,5 @@ The installer script also has an uninstall mode that will keep configuration fil
 
 ## Author
 
-Feel free to open an issue on github or mail me for support in my spare time :)
+Feel free to open an issue on GitHub or mail me for support in my spare time :)
 Orsiris de Jong | ozy@netpower.fr
diff --git a/dev/debug_osync.sh b/dev/debug_osync.sh
@@ -504,7 +504,7 @@ function SendAlert {
 	fi
 
 	if [ $runAlert == true ]; then
-		subject="Currently runing - $subject"
+		subject="Currently running - $subject"
 	else
 		subject="Finished run - $subject"
 	fi
diff --git a/dev/ofunctions.sh b/dev/ofunctions.sh
@@ -82,7 +82,7 @@ else
 	_LOGGER_VERBOSE=true
 fi
 
-if [ "$SLEEP_TIME" == "" ]; then # Leave the possibity to set SLEEP_TIME as environment variable when runinng with bash -x in order to avoid spamming console
+if [ "$SLEEP_TIME" == "" ]; then # Leave the possibility to set SLEEP_TIME as environment variable when running with bash -x in order to avoid spamming console
 	SLEEP_TIME=.05
 fi
 #### DEBUG SUBSET END ####
@@ -512,7 +512,7 @@ function SendAlert {
 	fi
 
 	if [ $runAlert == true ]; then
-		subject="Currently runing - $subject"
+		subject="Currently running - $subject"
 	else
 		subject="Finished run - $subject"
 	fi
@@ -786,7 +786,7 @@ function _PerfProfiler {												#__WITH_PARANOIA_DEBUG
 
 _OFUNCTIONS_SPINNER="|/-\\"
 function Spinner {
-	if [ $_LOGGER_SILENT == true ] || [ "$_LOGGER_ERR_ONLY" == true ] || [ "$_SYNC_ON_CHANGES" == "initiator" ] || [ "$_SYNC_ON_CHANGES" == "target" ] ; then
+	if [ "$_LOGGER_SILENT" == true ] || [ "$_LOGGER_ERR_ONLY" == true ] || [ "$_SYNC_ON_CHANGES" == "initiator" ] || [ "$_SYNC_ON_CHANGES" == "target" ] ; then
 		return 0
 	else
 		printf " [%c]  \b\b\b\b\b\b" "$_OFUNCTIONS_SPINNER"
diff --git a/install.sh b/install.sh
