Skip to content

Commit c409c51

Browse files
authored
Update README.md
1 parent e0a5033 commit c409c51

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,16 +51,18 @@ Example: this command will copy dataset 'foo' from remote server 'BOOMER' to the
5151
The module script (__rsync-module.sh__) is strictly _push_ oriented: it can only be used to copy data from the local system to a remote rsync module because the target specifier has the `rsync://` prefix hard-coded. But you could easily modify a copy of this script and put the `rsync://` prefix on the source specifier if you need _pull_ capability.
5252

5353
### Prerequisites: SSH
54-
Since __rsync__ uses __ssh__, you will need to configure __ssh__ key-based authentication to allow logging on to your target servers without having to enter a password.
54+
Since __rsync__ typically uses __ssh__, you will need to configure __ssh__ key-based authentication to allow logging on to your target servers without having to enter a password.
5555

5656
### Prerequisites: rsync modules
57-
You will need to configure __rsync__ modules if you plan to use them as targets. On my FreeNAS server 'BOOMER' I have configured a single __rsync__ module named 'tank', with a path of /mnt/tank', access mode of 'Read and Write', user 'root', and group 'wheel'.
57+
You will need to configure __rsync__ modules if you plan to use them as targets.
58+
59+
Example: on my FreeNAS server 'BOOMER' I have configured a single __rsync__ module named 'tank', with a path of '/mnt/tank', access mode of 'Read and Write', user 'root', and group 'wheel'.
5860

5961
### Slow Network Performance
6062

61-
Just about every __rsync__ user notices how slow it is at transferring data. This is usually due to using __ssh__ as the transport protocol, with its attendant encryption. A common approach to overcoming slow transfers is to use less CPU-intensive encryption algorithms or to do away with encryption altogether. I have found that using __rsync__ modules is faster than standalone mode, and that disabling encryption speeds up standalone transfers.
63+
Just about every __rsync__ user notices how slow it is at transferring data. This is usually due to using __ssh__ as the transport protocol, with its attendant encryption. A common approach to overcoming slow transfers is to use less CPU-intensive encryption algorithms or to do away with encryption altogether. I have found that using __rsync__ modules is much faster than standalone mode, and that disabling encryption speeds up standalone transfers.
6264

63-
On my 10Gb network, I get transfer rates of up to 2Gb/s using __rsync-module.sh__, which is quite a bit faster than the typical __rsync-invoke.sh__ rate of roughly 800Mb/s.
65+
On my 10Gb network, I get transfer rates of up to 2Gb/s using __rsync-module.sh__, quite a bit faster than the typical __rsync-invoke.sh__ rate of roughly 800Mb/s.
6466

6567
### Windows ACL Data
6668

@@ -79,7 +81,7 @@ To determine whether your environment supports copying Windows ACLs, explore the
7981

8082
### Options
8183

82-
These are the options used in both scripts:
84+
These are the __rsync__ options used in both scripts:
8385
```
8486
-r recurse into directories
8587
-l copy symlinks as symlinks
@@ -129,7 +131,7 @@ for dataset in $datasets; do
129131
done
130132
```
131133

132-
This script does exactly the same thing, only using __rsync-invoke.sh__ to call __rsync__ directly instead of targeting the remote server's module:
134+
This script does exactly the same thing, only using __rsync-invoke.sh__ to call __rsync__ directly:
133135
```
134136
#!/bin/sh
135137

0 commit comments

Comments
 (0)