-
Notifications
You must be signed in to change notification settings - Fork 103
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #263 from vitorhcl/improve-usage-section
Improve "Usage" section
- Loading branch information
Showing
1 changed file
with
47 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -86,15 +86,29 @@ 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 monitor mode. | ||
| While quick sync mode is convenient to do fast syncs between some directories, a configuration file gives much more functionality. | ||
| 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://[email protected]:22//path/to/dir2" --rsakey=/home/user/.ssh/id_rsa_private_key_example.com | ||
|
|
||
| #### 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://[email protected]: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 will output only file changes and errors with the following: | ||
|
|
@@ -103,33 +117,30 @@ osync will output only file changes and errors with the following: | |
|
|
||
| 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://[email protected]: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 the `/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: | ||
|
|
||
|
|
@@ -139,30 +150,36 @@ Please note that this syntax works for RedHat/CentOS. On Debian you might want t | |
|
|
||
| ### 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 | ||
|
|
||
| ### Monitor mode | ||
| ### <a id="monitor-mode"></a>:mag_right: Monitor mode | ||
|
|
||
| > [!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-tools package on these OSes. | ||
| > 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. | ||
| 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. | ||
|
|
||
| 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 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 (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. | ||
| To use this mode, use `--on-changes`: | ||
|
|
||
| # osync.sh /etc/osync/my_sync.conf --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, [email protected] to `/usr/lib/systemd/system` for systemd, osync-srv-openrc to `/etc/init.d/osync-srv-openrc` for OpenRC). | ||
| 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, `[email protected]` to `/usr/lib/systemd/system` | ||
| - For OpenRC, `osync-srv-openrc` to `/etc/init.d/osync-srv-openrc` | ||
|
|
||
| For InitV (any configuration file found in `/etc/osync` will create an osync daemon instance when service is launched on initV): | ||
|
|
||
|
|
||