-
Notifications
You must be signed in to change notification settings - Fork 0
/
mod_rsync.html
180 lines (153 loc) · 4.91 KB
/
mod_rsync.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
<html>
<head>
<title>ProFTPD module mod_rsync</title>
</head>
<body bgcolor=white>
<hr>
<center>
<h2><b>ProFTPD module <code>mod_rsync</code></b></h2>
</center>
<hr><br>
<p>
The purpose of the <code>mod_rsync</code> module is to support rsync data
transfers to/from a ProFTPD server.
<p>
The <code>mod_rsync</code> module relies on the following libraries:
<ul>
<li>popt (<i>e.g.</i> the <code>libcurl4-dev</code> package)
</ul>
<p>
Installation instructions are discussed <a href="#Installation">here</a>;
detailed notes on best practices for using this module are
<a href="#Usage">here</a>.
<p>
The most current version of <code>mod_rsync</code> can be found at:
<pre>
<a href="https://github.com/Castaglia/proftpd-mod_rsync">https://github.com/Castaglia/proftpd-mod_rsync</a>
</pre>
<p>
This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (http://www.openssl.org/).
<p>
This product includes cryptographic software written by Eric Young ([email protected]).
<h2>Author</h2>
<p>
Please contact TJ Saunders <tj <i>at</i> castaglia.org> with any
questions, concerns, or suggestions regarding this module.
<h2>Directives</h2>
<ul>
<li><a href="#RSyncEngine">RSyncEngine</a>
<li><a href="#RSyncLog">RSyncLog</a>
<li><a href="#RSyncOptions">RSyncOptions</a>
</ul>
<p>
<hr>
<h3><a name="RSyncEngine">RSyncEngine</a></h3>
<strong>Syntax:</strong> RSyncEngine <em>on|off</em><br>
<strong>Default:</strong> None<br>
<strong>Context:</strong> server config<br>
<strong>Module:</strong> mod_rsync<br>
<strong>Compatibility:</strong> 1.3.6rc2 and later
<p>
The <code>RSyncEngine</code> directive enables support for rsync transfers.
<p>
<hr>
<h3><a name="RSyncLog">RSyncLog</a></h3>
<strong>Syntax:</strong> RSyncLog <em>path</em><br>
<strong>Default:</strong> None<br>
<strong>Context:</strong> server config<br>
<strong>Module:</strong> mod_rsync<br>
<strong>Compatibility:</strong> 1.3.6rc2 and later
<p>
The <code>RSyncLog</code> directive is used to specify a log file for
<code>mod_rsync</code>'s reporting. The <em>path</em> parameter given must be
the full path to the file to use for logging.
<p>
Note that this path must <b>not</b> be to a world-writable directory and,
unless <code>AllowLogSymlinks</code> is explicitly set to <em>on</em>
(generally a bad idea), the path must <b>not</b> be a symbolic link.
<p>
<hr>
<h3><a name="RSyncOptions">RSyncOptions</a></h3>
<strong>Syntax:</strong> RSyncOptions <em>opt1 ...</em><br>
<strong>Default:</strong> None<br>
<strong>Context:</strong> server config<br>
<strong>Module:</strong> mod_rsync<br>
<strong>Compatibility:</strong> 1.3.6rc2 and later
<p>
The <code>RSyncOptions</code> directive is used to configure various optional
behavior of <code>mod_rsync</code>.
<p>
The currently implemented options are:
<ul>
</ul>
<p>
<hr>
<h2><a name="Usage">Usage</a></h2>
<b>Example Configuration</b>
<pre>
<IfModule mod_rsync.c>
RSyncEngine on
RSyncLog /var/log/ftpd/rsync.log
</IfModule>
</pre>
<p>
<b>Logging</b><br>
The <code>mod_rsync</code> module supports different forms of logging. The
main module logging is done via the <code>RSyncLog</code> directive.
<p>
For debugging purposes, the module also uses
<a href="http://www.proftpd.org/docs/howto/Tracing.html">trace logging</a>,
via the module-specific channels:
<ul>
<li>rsync
</ul>
Thus for trace logging, to aid in debugging, you would use the following in
your <code>proftpd.conf</code>:
<pre>
TraceLog /path/to/rsync-trace.log
Trace rsync:20
</pre>
This trace logging can generate large files; it is intended for debugging
use only, and should be removed from any production configuration.
<p><a name="FAQ">
<b>Frequently Asked Questions</b><br>
<p>
<hr>
<h2><a name="Installation">Installation</a></h2>
To install <code>mod_rsync</code>, go to the third-party module area in
the proftpd source code and unpack the <code>mod_rsync</code> source tarball:
<pre>
$ cd <i>proftpd-dir</i>/contrib/
$ tar zxvf /path/to/mod_rsync-<i>version</i>.tar.gz
</pre>
after unpacking the latest proftpd-1.3.<i>x</i> source code. For including
<code>mod_rsync</code> as a staticly linked module:
<pre>
$ ./configure --enable-openssl --with-modules=mod_sftp:mod_rsync ... \
--with-includes=/path/to/openssl/include \
--with-libraries=/path/to/openssl/lib
</pre>
To build <code>mod_rsync</code> as a DSO module:
<pre>
$ ./configure --enable-dso --enable-openssl --with-shared=mod_sftp:mod_rsync ... \
--with-includes=/path/to/openssl/include \
--with-libraries=/path/to/openssl/lib
</pre>
Then follow the usual steps:
<pre>
$ make
$ make install
</pre>
<b>Note</b>: <code>mod_rsync</code> uses the
<a href="http://www.openssl.org/"<code>OpenSSL</code></a> library; thus the
development libraries/headers <b>must</b> be installed for building
<code>mod_rsync</code>.
<p>
<hr>
<font size=2><b><i>
© Copyright 2016 TJ Saunders<br>
All Rights Reserved<br>
</i></b></font>
<hr>
</body>
</html>