Fixing some typos and grammar errors.
This commit is contained in:
parent
591e66ae7c
commit
f572a48a3b
|
@ -91,7 +91,7 @@
|
||||||
\begin_body
|
\begin_body
|
||||||
|
|
||||||
\begin_layout Title
|
\begin_layout Title
|
||||||
Osync v1.00 Documentation
|
Osync v1.00a Documentation
|
||||||
\end_layout
|
\end_layout
|
||||||
|
|
||||||
\begin_layout Author
|
\begin_layout Author
|
||||||
|
@ -107,7 +107,7 @@ Ozy
|
||||||
\end_layout
|
\end_layout
|
||||||
|
|
||||||
\begin_layout Date
|
\begin_layout Date
|
||||||
02 July 2015
|
22 August 2015
|
||||||
\end_layout
|
\end_layout
|
||||||
|
|
||||||
\begin_layout Standard
|
\begin_layout Standard
|
||||||
|
@ -156,7 +156,7 @@ Osync is a command line two way synchronization tool for Linux / BSD / MacOSX
|
||||||
\end_layout
|
\end_layout
|
||||||
|
|
||||||
\begin_layout Standard
|
\begin_layout Standard
|
||||||
A quickstart guide might be found in the README.md file.
|
A quickstart guide can be found in the README.md file.
|
||||||
\end_layout
|
\end_layout
|
||||||
|
|
||||||
\begin_layout Subsection
|
\begin_layout Subsection
|
||||||
|
@ -264,8 +264,8 @@ It will trigger a warning email including the whole sync process execution
|
||||||
|
|
||||||
\begin_layout Standard
|
\begin_layout Standard
|
||||||
Pre-processing and post-processing commands can be launched on local and
|
Pre-processing and post-processing commands can be launched on local and
|
||||||
/ or remote systems, which may be usefull to launch snapshot software,
|
/ or remote systems, which may be useful to launch snapshot software, flush
|
||||||
flush or standby virtual machines, etc).
|
or standby virtual machines, etc).
|
||||||
\end_layout
|
\end_layout
|
||||||
|
|
||||||
\begin_layout Standard
|
\begin_layout Standard
|
||||||
|
@ -550,7 +550,7 @@ status open
|
||||||
|
|
||||||
\begin_layout Plain Layout
|
\begin_layout Plain Layout
|
||||||
|
|
||||||
# setfacl -mR d:g:r-x,g:r-x /home/web
|
# setfacl -dRm u:syncuser:r-x /home/web
|
||||||
\end_layout
|
\end_layout
|
||||||
|
|
||||||
\end_inset
|
\end_inset
|
||||||
|
@ -559,7 +559,7 @@ status open
|
||||||
\end_layout
|
\end_layout
|
||||||
|
|
||||||
\begin_layout Standard
|
\begin_layout Standard
|
||||||
Be aware that ACLs are tricky and default group permissions serve as mask
|
Be aware that ACLs are tricky and default unix permissions serve as mask
|
||||||
for ACLs.
|
for ACLs.
|
||||||
\end_layout
|
\end_layout
|
||||||
|
|
||||||
|
@ -628,7 +628,8 @@ In order to be able to use the sudo command without having to enter a password,
|
||||||
\end_layout
|
\end_layout
|
||||||
|
|
||||||
\begin_layout Standard
|
\begin_layout Standard
|
||||||
Edit the file /etc/sudoers and add the following
|
Use visudo to edit the sudoers file (or carefully edit /etc/sudoers yourself)
|
||||||
|
and add the following
|
||||||
\end_layout
|
\end_layout
|
||||||
|
|
||||||
\begin_layout Standard
|
\begin_layout Standard
|
||||||
|
@ -852,7 +853,8 @@ keys
|
||||||
\end_layout
|
\end_layout
|
||||||
|
|
||||||
\begin_layout Standard
|
\begin_layout Standard
|
||||||
Make sure the file is readable by the syncuser on the remote system.
|
Make sure the file is only readable and owned by the syncuser on the remote
|
||||||
|
system.
|
||||||
\end_layout
|
\end_layout
|
||||||
|
|
||||||
\begin_layout Standard
|
\begin_layout Standard
|
||||||
|
@ -1244,6 +1246,91 @@ Also, edit RSYNC_EXECUTABLE value on any of your sync configuration files
|
||||||
|
|
||||||
\end_layout
|
\end_layout
|
||||||
|
|
||||||
|
\begin_layout Section
|
||||||
|
Getting Osync
|
||||||
|
\end_layout
|
||||||
|
|
||||||
|
\begin_layout Standard
|
||||||
|
Osync can be downloaded on the author's site (stable version) or on github
|
||||||
|
(stable or latest dev snapshot).
|
||||||
|
\end_layout
|
||||||
|
|
||||||
|
\begin_layout Standard
|
||||||
|
Getting osync via author's site
|
||||||
|
\end_layout
|
||||||
|
|
||||||
|
\begin_layout Standard
|
||||||
|
\begin_inset listings
|
||||||
|
inline false
|
||||||
|
status open
|
||||||
|
|
||||||
|
\begin_layout Plain Layout
|
||||||
|
|
||||||
|
wget http://netpower.fr/projects/osync/osync.v1.00a.tar.gz
|
||||||
|
\end_layout
|
||||||
|
|
||||||
|
\begin_layout Plain Layout
|
||||||
|
|
||||||
|
tar xvf osync.v1.00a.tar.gz
|
||||||
|
\end_layout
|
||||||
|
|
||||||
|
\end_inset
|
||||||
|
|
||||||
|
|
||||||
|
\end_layout
|
||||||
|
|
||||||
|
\begin_layout Standard
|
||||||
|
Getting osync via github (remove the -b
|
||||||
|
\begin_inset Quotes sld
|
||||||
|
\end_inset
|
||||||
|
|
||||||
|
v1.00a
|
||||||
|
\begin_inset Quotes srd
|
||||||
|
\end_inset
|
||||||
|
|
||||||
|
if you want latest dev snapshot)
|
||||||
|
\end_layout
|
||||||
|
|
||||||
|
\begin_layout Standard
|
||||||
|
\begin_inset listings
|
||||||
|
inline false
|
||||||
|
status open
|
||||||
|
|
||||||
|
\begin_layout Plain Layout
|
||||||
|
|
||||||
|
git clone -b "v1.00a" https://github.com/deajan/osync
|
||||||
|
\end_layout
|
||||||
|
|
||||||
|
\end_inset
|
||||||
|
|
||||||
|
|
||||||
|
\end_layout
|
||||||
|
|
||||||
|
\begin_layout Standard
|
||||||
|
Once you downloaded osync, enter into the newly created folder and run the
|
||||||
|
install script
|
||||||
|
\end_layout
|
||||||
|
|
||||||
|
\begin_layout Standard
|
||||||
|
\begin_inset listings
|
||||||
|
inline false
|
||||||
|
status open
|
||||||
|
|
||||||
|
\begin_layout Plain Layout
|
||||||
|
|
||||||
|
sh ./install.sh
|
||||||
|
\end_layout
|
||||||
|
|
||||||
|
\end_inset
|
||||||
|
|
||||||
|
|
||||||
|
\end_layout
|
||||||
|
|
||||||
|
\begin_layout Standard
|
||||||
|
This will copy osync to /usr/local/bin and create /etc/osync with a test
|
||||||
|
sync.conf file.
|
||||||
|
\end_layout
|
||||||
|
|
||||||
\begin_layout Section
|
\begin_layout Section
|
||||||
\begin_inset CommandInset label
|
\begin_inset CommandInset label
|
||||||
LatexCommand label
|
LatexCommand label
|
||||||
|
@ -1255,31 +1342,7 @@ Running osync in quicksync mode
|
||||||
\end_layout
|
\end_layout
|
||||||
|
|
||||||
\begin_layout Standard
|
\begin_layout Standard
|
||||||
You must first download a copy of osync to your computer, and make it executable.
|
You just osync to sync two local dirs like this:
|
||||||
\end_layout
|
|
||||||
|
|
||||||
\begin_layout Standard
|
|
||||||
You may also use the included install.sh script which will put osync in /usr/loca
|
|
||||||
l/bin.
|
|
||||||
\end_layout
|
|
||||||
|
|
||||||
\begin_layout Standard
|
|
||||||
\begin_inset listings
|
|
||||||
inline false
|
|
||||||
status open
|
|
||||||
|
|
||||||
\begin_layout Plain Layout
|
|
||||||
|
|
||||||
$ chmod +x osync.sh
|
|
||||||
\end_layout
|
|
||||||
|
|
||||||
\end_inset
|
|
||||||
|
|
||||||
|
|
||||||
\end_layout
|
|
||||||
|
|
||||||
\begin_layout Standard
|
|
||||||
Then you might just launch it to sync two local dirs like this:
|
|
||||||
\end_layout
|
\end_layout
|
||||||
|
|
||||||
\begin_layout Standard
|
\begin_layout Standard
|
||||||
|
@ -1410,8 +1473,8 @@ $ ./osync.sh /etc/osync/my_sync.conf --no-maxtime
|
||||||
|
|
||||||
\begin_layout Standard
|
\begin_layout Standard
|
||||||
Creating a regular sync scenario is quite simple as long as you don't schedule
|
Creating a regular sync scenario is quite simple as long as you don't schedule
|
||||||
two times the same sync task in a shorter time span than your HARD_MAX_EXEC_TIM
|
twice the same sync task in a shorter time span than your HARD_MAX_EXEC_TIME_TO
|
||||||
E_TOTAL value.
|
TAL value.
|
||||||
Just create a crontab entry and add parameter --silent so your local mailbox
|
Just create a crontab entry and add parameter --silent so your local mailbox
|
||||||
won't get filled up.
|
won't get filled up.
|
||||||
Example, having a sync scheduled every hour in /etc/crontab
|
Example, having a sync scheduled every hour in /etc/crontab
|
||||||
|
@ -1449,8 +1512,8 @@ Manually
|
||||||
|
|
||||||
\begin_layout Standard
|
\begin_layout Standard
|
||||||
Osync may also run in file monitor mode.
|
Osync may also run in file monitor mode.
|
||||||
In this mode, osync monitors the master replica, and runs a synchronization
|
In this mode, osync checks the master replica, and runs a synchronization
|
||||||
everytime the is file activity on master replica.
|
as soon as there is file activity on master replica.
|
||||||
With this mode, you do not need a schedule anymore.
|
With this mode, you do not need a schedule anymore.
|
||||||
Be aware that only master replica is monitored, and slave replica sync
|
Be aware that only master replica is monitored, and slave replica sync
|
||||||
updates only occur when master replica modifications happen.
|
updates only occur when master replica modifications happen.
|
||||||
|
@ -1600,7 +1663,7 @@ Both quicksync and config file modes can take the following optional parameters:
|
||||||
\labelwidthstring 00.00.0000
|
\labelwidthstring 00.00.0000
|
||||||
--no-maxtime Will disable MAX_EXEC_TIME checks, so a task can take as long
|
--no-maxtime Will disable MAX_EXEC_TIME checks, so a task can take as long
|
||||||
as it needs.
|
as it needs.
|
||||||
This is usefull for performing initial big sync operations
|
This is useful for performing initial big sync operations
|
||||||
\end_layout
|
\end_layout
|
||||||
|
|
||||||
\begin_layout Labeling
|
\begin_layout Labeling
|
||||||
|
@ -1967,7 +2030,7 @@ SSH_COMPRESSION=yes|no
|
||||||
|
|
||||||
\begin_layout Standard
|
\begin_layout Standard
|
||||||
Ping remote host before launching synchronization.
|
Ping remote host before launching synchronization.
|
||||||
Be sure the host responds to ping.
|
Be sure the host is responding to ping.
|
||||||
Failing to ping will skip current task.
|
Failing to ping will skip current task.
|
||||||
\end_layout
|
\end_layout
|
||||||
|
|
||||||
|
@ -2271,7 +2334,7 @@ CONFLICT_BACKUP_DAYS=30
|
||||||
|
|
||||||
\begin_layout Standard
|
\begin_layout Standard
|
||||||
If the same file exists on both replicas, newer version will be synced.
|
If the same file exists on both replicas, newer version will be synced.
|
||||||
However, if both files have the same timestamp but differ, CONFILCT_PREVALANCE
|
However, if both files have the same timestamp but differ, CONFLICT_PREVALANCE
|
||||||
sets winner replica.
|
sets winner replica.
|
||||||
\begin_inset listings
|
\begin_inset listings
|
||||||
inline false
|
inline false
|
||||||
|
@ -2390,8 +2453,8 @@ FORCE_STRANGER_LOCK_RESUME=no
|
||||||
\end_layout
|
\end_layout
|
||||||
|
|
||||||
\begin_layout Standard
|
\begin_layout Standard
|
||||||
Keep partial uploads that can be resumed on next run, experimantal feature.
|
Keep partial uploads that can be resumed on next run, experimental feature.
|
||||||
This can be very usefull if big files must get updated though slow links.
|
This can be very useful if big files must get updated though slow links.
|
||||||
\end_layout
|
\end_layout
|
||||||
|
|
||||||
\begin_layout Standard
|
\begin_layout Standard
|
||||||
|
@ -2702,9 +2765,9 @@ Final words
|
||||||
\end_layout
|
\end_layout
|
||||||
|
|
||||||
\begin_layout Standard
|
\begin_layout Standard
|
||||||
The idea came in a discussion around a nice beer one evening.
|
The idea of osync came in a discussion around a nice beer one evening.
|
||||||
It began as a project for a friend, who's company I was working for as
|
It began as a project for a friend, whose company I was working for as
|
||||||
consultant.
|
a consultant.
|
||||||
\end_layout
|
\end_layout
|
||||||
|
|
||||||
\begin_layout Standard
|
\begin_layout Standard
|
||||||
|
@ -2712,8 +2775,8 @@ Today, osync is still used by this company, and some others around the globe.
|
||||||
\end_layout
|
\end_layout
|
||||||
|
|
||||||
\begin_layout Standard
|
\begin_layout Standard
|
||||||
I will try to provide technical help in my spare time for this project,
|
I try to provide technical help and support in my spare time, and will appreciat
|
||||||
and appreciate every contribution i get on Github :)
|
e every contribution i get on Github :)
|
||||||
\end_layout
|
\end_layout
|
||||||
|
|
||||||
\begin_layout Standard
|
\begin_layout Standard
|
Loading…
Reference in New Issue