| 1 |
.\" man page for drpmsync |
| 2 |
.\" Copyright (c) 2005 Michael Schroeder <[email protected]> |
| 3 |
.\" See LICENSE.BSD for license |
| 4 |
.TH DRPMSYNC 8 "Jun 2005" |
| 5 |
.SH NAME |
| 6 |
drpmsync \- sync a file tree with deltarpms |
| 7 |
|
| 8 |
.SH SYNOPSIS |
| 9 |
.B drpmsync |
| 10 |
.RB [ -c |
| 11 |
.IR config ] |
| 12 |
.RI [ source ] |
| 13 |
.I dir |
| 14 |
.br |
| 15 |
.B drpmsync |
| 16 |
.RB [ -s | -S ] |
| 17 |
.I serverconfig |
| 18 |
.br |
| 19 |
.B cgi-bin/drpmsync |
| 20 |
|
| 21 |
.SH DESCRIPTION |
| 22 |
Drpmsync keeps a local file system tree in sync with a remote one. |
| 23 |
Its intended use is to work with rpm trees; the deltarpm technology |
| 24 |
can only save bandwidth if rpms get transmitted. Please use the |
| 25 |
rsync program for normal file trees. |
| 26 |
|
| 27 |
Drpmsync can run in two modes: as a client it connects to a server, |
| 28 |
receives a file list and brings the tree up to date, as a server |
| 29 |
it answers incoming requests and transmits files and rpms. |
| 30 |
|
| 31 |
.SH CLIENT MODE |
| 32 |
In this mode drpmsync updates the tree in |
| 33 |
.IR dir . |
| 34 |
It opens the configuration file |
| 35 |
.IB dir /drpmsync/config |
| 36 |
to get information about which server to use and other settings. |
| 37 |
You can specify a different configuration file with the |
| 38 |
.B -c |
| 39 |
option. |
| 40 |
The following settings are understood (the default for the boolean |
| 41 |
settings is false): |
| 42 |
.sp |
| 43 |
.ne 3 |
| 44 |
.B source: |
| 45 |
.I server1 |
| 46 |
.IR server2 ... |
| 47 |
.PP |
| 48 |
This is a list of servers to connect to. Drpmsync advances through |
| 49 |
this list until a working server is found. If a source is specified |
| 50 |
on the command line it is used instead of the one from the |
| 51 |
configuration. The syntax for the server entries is |
| 52 |
"\fIhost\fP[\fB:\fP\fIport\fP]/\fItree\fP". |
| 53 |
.sp |
| 54 |
.ne 3 |
| 55 |
.B log: |
| 56 |
.I logfile |
| 57 |
.PP |
| 58 |
Specifies the name of a logfile. If the name does not start with |
| 59 |
a slash, |
| 60 |
.IB dir /drpmsync/ |
| 61 |
is prepended to it. |
| 62 |
.sp |
| 63 |
.ne 3 |
| 64 |
.B generate_deltas: |
| 65 |
.BR true|false |
| 66 |
.PP |
| 67 |
Controls whether drpmsync generates a delta if it receives a new |
| 68 |
version of a rpm and the server doesn't provide a delta. This |
| 69 |
is only useful if the local tree is also exported to other clients |
| 70 |
via a local drpmsync server. |
| 71 |
.sp |
| 72 |
.ne 3 |
| 73 |
.B generate_delta_compression: |
| 74 |
.I comp |
| 75 |
.PP |
| 76 |
This parameter is forwarded to the makedeltarpm program when |
| 77 |
creating deltas. An example would be |
| 78 |
.BR gzip,gzip . |
| 79 |
.sp |
| 80 |
.ne 3 |
| 81 |
.B keep_deltas: |
| 82 |
.BR true|false |
| 83 |
.PP |
| 84 |
Tell drpmsync to save received or freshly created deltas to the |
| 85 |
.IB dir /drpmsync/delta |
| 86 |
directory. Automatically true if |
| 87 |
.B generate_deltas |
| 88 |
or |
| 89 |
.B keep_uncombined |
| 90 |
is set to true. |
| 91 |
.sp |
| 92 |
.ne 3 |
| 93 |
.B keep_uncombined: |
| 94 |
.BR true|false |
| 95 |
.PP |
| 96 |
This tells drpmsync to request uncombined deltas from the server instead |
| 97 |
of a precombined single delta. This makes sense if you re-export the |
| 98 |
tree and want to maximize the number of versions your clients can |
| 99 |
update from. |
| 100 |
.sp |
| 101 |
.ne 3 |
| 102 |
.B always_get_rpm: |
| 103 |
.BR true|false |
| 104 |
.PP |
| 105 |
Configures whether drpmsync should request that the full rpm is |
| 106 |
always sent along with the delta. Only makes sense if you have a |
| 107 |
fast network connection so that applydeltarpm takes longer than |
| 108 |
transmitting the full rpm. |
| 109 |
.sp |
| 110 |
.ne 3 |
| 111 |
.B deltarpmpath: |
| 112 |
.I path |
| 113 |
.PP |
| 114 |
Sets the directory where drpmsync searches for the deltarpm programs. |
| 115 |
The default is to search the |
| 116 |
.B $PATH |
| 117 |
variable. |
| 118 |
|
| 119 |
.SH SERVER MODE |
| 120 |
Drpmsync can either work as CGI script or as a standalone server. |
| 121 |
CGI script mode is automatically selected if the |
| 122 |
.B REQUEST_METHOD |
| 123 |
environment variable is set. In this mode drpmsync expects the |
| 124 |
.B DRPMSYNC_CONFIG |
| 125 |
environment variable to contain the path to a server config file. |
| 126 |
For apache you can set this with the |
| 127 |
.B SetEnv |
| 128 |
directive. |
| 129 |
|
| 130 |
Standalone mode is selected with the |
| 131 |
.B -s |
| 132 |
or |
| 133 |
.B -S |
| 134 |
option. In this mode the server configuration must be specified as |
| 135 |
an argument to the drpmsync program. The |
| 136 |
.B -s |
| 137 |
option makes the drpmsync program background itself and exit right |
| 138 |
away, while |
| 139 |
.B -S |
| 140 |
keeps the server in the foreground. |
| 141 |
|
| 142 |
The server configuration can contain the following settings: |
| 143 |
.sp |
| 144 |
.ne 3 |
| 145 |
.B allow: |
| 146 |
.I pattern1 |
| 147 |
.IR pattern2 ... |
| 148 |
.br |
| 149 |
.B deny: |
| 150 |
.I pattern1 |
| 151 |
.IR pattern2 ... |
| 152 |
.PP |
| 153 |
This provides the access control for the server. |
| 154 |
.I pattern |
| 155 |
can either be a simple glob pattern (only |
| 156 |
.B * |
| 157 |
is supported) or it can be a full regular expression if it is written |
| 158 |
as |
| 159 |
.BR /RE/ . |
| 160 |
The regular expression is automatically anchored at the start and the |
| 161 |
end. Examples are |
| 162 |
.B 10.10.* |
| 163 |
or |
| 164 |
.BR /10\e.10\e..*/ |
| 165 |
If either the numerical ip address or the domain name of the client |
| 166 |
matches any entry of the deny list, access is forbidden. Otherwise |
| 167 |
the allow list is searched for a match. If none is found, access |
| 168 |
is also denied. The default setting for both lists is empty, so |
| 169 |
you have to provide an allow list to allow access for the clients. |
| 170 |
.sp |
| 171 |
.ne 3 |
| 172 |
.B log: |
| 173 |
.I logfile |
| 174 |
.PP |
| 175 |
Specifies the path of a logfile. |
| 176 |
.sp |
| 177 |
.ne 3 |
| 178 |
.B no_combine: |
| 179 |
.BR true|false |
| 180 |
.PP |
| 181 |
If this setting is true the server does not combine deltarpms. |
| 182 |
This increases the amount of data that has to be transferred but |
| 183 |
reduces the processor load on the server. |
| 184 |
.sp |
| 185 |
.ne 3 |
| 186 |
.B tree: |
| 187 |
.I external_path |
| 188 |
.I internal_path |
| 189 |
.PP |
| 190 |
This statements exports the tree located at |
| 191 |
.I internal_path |
| 192 |
to the clients as directory |
| 193 |
.IR external_path . |
| 194 |
All of the above settings are saved as settings of this particular |
| 195 |
tree, so different trees can use different configurations. This |
| 196 |
also means that the configuration directives of a tree must be |
| 197 |
above the |
| 198 |
.B tree |
| 199 |
statement. |
| 200 |
.sp |
| 201 |
.sp |
| 202 |
.ne 3 |
| 203 |
The following settings are global and only needed for standalone mode: |
| 204 |
.sp |
| 205 |
.ne 3 |
| 206 |
.B serverlog: |
| 207 |
.I logfile |
| 208 |
.PP |
| 209 |
Specifies the path of a logfile used for logging server events. |
| 210 |
.sp |
| 211 |
.ne 3 |
| 212 |
.B servername: |
| 213 |
.IR hostname [: port ] |
| 214 |
.PP |
| 215 |
The name of the server. If |
| 216 |
.I hostname |
| 217 |
is empty, the fully qualified domain name is used instead. The port |
| 218 |
defaults to port 80. |
| 219 |
.sp |
| 220 |
.ne 3 |
| 221 |
.B serveraddr: |
| 222 |
.I addr |
| 223 |
.PP |
| 224 |
This address is used for binding the server's socket. If not specified, |
| 225 |
connections can come from any interface. |
| 226 |
.sp |
| 227 |
.ne 3 |
| 228 |
.BI serveruser: |
| 229 |
.I user |
| 230 |
.br |
| 231 |
.BI servergroup: |
| 232 |
.I group |
| 233 |
.PP |
| 234 |
Configures the user and group the servers swicthes to after binding |
| 235 |
the socket to the desired port. Examples are |
| 236 |
.B nobody |
| 237 |
or |
| 238 |
.BR wwwrun . |
| 239 |
.sp |
| 240 |
.ne 3 |
| 241 |
.BI maxclients: |
| 242 |
.I num |
| 243 |
.PP |
| 244 |
This settings limits the maximum number of concurrent connections to |
| 245 |
.IR num . |
| 246 |
The default value is 10 connections. |
| 247 |
.sp |
| 248 |
.ne 3 |
| 249 |
.B deltarpmpath: |
| 250 |
.I path |
| 251 |
.PP |
| 252 |
Sets the directory where drpmsync searches for the deltarpm programs. |
| 253 |
The default is to search the |
| 254 |
.B $PATH |
| 255 |
variable. |
| 256 |
|
| 257 |
.SH FILES |
| 258 |
.PD 0 |
| 259 |
.IP \fIdir\fP/drpmsync/deltas |
| 260 |
directory used to store the deltas |
| 261 |
.IP \fIdir\fP/drpmsync/lock |
| 262 |
lock used to serialize syncrpm calls |
| 263 |
.IP \fIdir\fP/drpmsync/wip |
| 264 |
temporary storing space for the transmitted objects |
| 265 |
.IP \fIdir\fP/drpmsync/cache |
| 266 |
md5sum cache to speed up the calculation of the tree state |
| 267 |
.IP \fIdir\fP/drpmsync/timstamp |
| 268 |
contains the time of the last finished sync and the last time the |
| 269 |
remote tree state was requested. |
| 270 |
|
| 271 |
.SH SEE ALSO |
| 272 |
.BR makedeltarpm (8), |
| 273 |
.BR combinedeltarpm (8), |
| 274 |
.BR applydeltarpm (8), |
| 275 |
|
| 276 |
.SH AUTHOR |
| 277 |
Michael Schroeder <[email protected]> |