summaryrefslogtreecommitdiffstats
path: root/lib/Plugins/abrt-FileTransfer.7
blob: 3004e88a93efbdefda4551e62c964c6fd71c3f3a (plain)
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
.TH abrt "7" "1 Jun 2009" ""
.SH NAME
FileTransfer plugin for abrt(8)
.SH DESCRIPTION
.P
.I abrt
is a daemon which watches for application crashes. When a crash occurs,
it collects the crash data and does some actions according to 
the configuration. This manual page describes the \fIFileTransfer\fP plugin 
for \fIabrt\fP.
.P
This plugin is used to transfer the crash report to another
machine via some file transfer protocol. Supported protocols
are FTP, FTPS, HTTP, HTTPS, SCP, SFTP and TFTP. 
.SH INVOCATION
.P
The plugin is invoked in the \fIabrt.conf\fP file, usually in the
\fIActionsAndReporters\fP option and/or the \fI[cron]\fP section.
There are two modes of invocation: either you use the parameter
\fI"store"\fP: in this case, the plugin stores the information,
that the crash occurs, in its internal list.
.P
If you use some other parameter, or no parameter at all, the
plugin will iterate through the internal list and will send
every recorded crash to the server specified in the \fIFileTransfer.conf\fP
configuration file. After that, the internal list is cleared.
.P
The rationale of this behavior is this: on a production
machine, you probably don't want the crash data to be
sent in the time the machine is busy working, you want
to send everything in some more quiet time (at night, perhaps)
and schedule this in the \fI[cron]\fP section of \fIabrt.conf\fP.
.SH CONFIGURATION
The \fIFileTransfer.conf\fP configuration file contains the following:
.SS URL
The URL of the server, where the crash should
be transfered, specifying the protocol, the path,
the user name and the password, for example
.br
URL = ftp://user:passwd@server.com/path
.SS ArchiveType
The type of the archive, where the crash data will be packed. 
Currently supporting \fI.tar.gz\fP, \fI.tar.bz2\fP and \fI.zip\fP
The plugin currently relies on external file archiving
commandline utilities, which will create the archive.
The default is
.br
ArchiveType = .tar.gz
.SS RetryCount
This specifies, how many times will the plugin try to resend
the file in the case the transfer was not succesful. The plugin
waits a while before it retries the transfer: see \fIRetryDelay\fP
The default is
.br
RetryCount = 3
.SS RetryDelay
In the case the transfer was not succesful, the plugin will
wait some time before sending the file again. This configuration
option specifies the time in seconds. The default is
.br
RetryDelay = 20
.SH EXAMPLES
Typical configuration in \fIabrt.conf\fP. The crash is stored
each time it happens and on midnight, all the crash data
is transferred to a central server.
.br
[common]
.br
ActionsAndReporters = FileTransfer("store")
.br
[cron]
.br
00:00 = FileTransfer
.SH "SEE ALSO"
.IR abrt (8),
.IR abrt.conf (5),
.IR abrt-plugins (7)
.SH AUTHOR
Written by Daniel Novotny <dnovotny@redhat.com>.