Blame doc/reporter-rhtsupport.txt

Packit 4f15d5
reporter-rhtsupport(1)
Packit 4f15d5
======================
Packit 4f15d5
Packit 4f15d5
NAME
Packit 4f15d5
----
Packit 4f15d5
reporter-rhtsupport - Reports problem to RHTSupport.
Packit 4f15d5
Packit 4f15d5
SYNOPSIS
Packit 4f15d5
--------
Packit 4f15d5
'reporter-rhtsupport' [-v] [-c CONFFILE] [-F FMTFILE] -d DIR
Packit 4f15d5
Packit 4f15d5
Or:
Packit 4f15d5
Packit 4f15d5
'reporter-rhtsupport' [-v] [-c CONFFILE] [-d DIR] -t[ID] FILE...
Packit 4f15d5
Packit 4f15d5
DESCRIPTION
Packit 4f15d5
-----------
Packit 4f15d5
The tool reads problem directory DIR. Then it logs in to RHTSupport
Packit 4f15d5
and creates a new case.
Packit 4f15d5
Packit 4f15d5
The URL to new case is printed to stdout and recorded in 'reported_to'
Packit 4f15d5
element in DIR.
Packit 4f15d5
Packit 4f15d5
If not specified, CONFFILE defaults to /etc/libreport/plugins/rhtsupport.conf
Packit 4f15d5
and to user's local ~/.config/libreport/rhtsupport.conf.
Packit 4f15d5
User's local configuration overrides the system wide configuration.
Packit 4f15d5
Packit 4f15d5
Option -t uploads FILEs to the already created case on RHTSupport site.
Packit 4f15d5
The case ID is retrieved from directory specified by -d DIR.
Packit 4f15d5
If problem data in DIR was never reported to RHTSupport, you will be asked
Packit 4f15d5
to enter case ID to which you want to upload the FILEs.
Packit 4f15d5
Packit 4f15d5
Option -tCASE uploads FILEs to the case CASE on RHTSupport site.
Packit 4f15d5
-d DIR is ignored.
Packit 4f15d5
Packit 4f15d5
Configuration file
Packit 4f15d5
~~~~~~~~~~~~~~~~~~
Packit 4f15d5
Configuration file lines should have 'PARAM = VALUE' format. The parameters are:
Packit 4f15d5
Packit 4f15d5
'Login'::
Packit 4f15d5
	Login to RHTSupport account.
Packit 4f15d5
Packit 4f15d5
'Password'::
Packit 4f15d5
	Password to RHTSupport account.
Packit 4f15d5
Packit 4f15d5
'URL'::
Packit 4f15d5
	HTTP(S) address. (default: https://api.access.redhat.com/rs)
Packit 4f15d5
Packit 4f15d5
'SSLVerify'::
Packit 4f15d5
	Use yes/true/on/1 to verify server's SSL certificate. (default: yes)
Packit 4f15d5
Packit 4f15d5
Parameters can be overridden via $RHTSupport_PARAM environment variables.
Packit 4f15d5
Packit 4f15d5
Integration with ABRT events
Packit 4f15d5
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Packit 4f15d5
'reporter-rhtsupport' can be used as an ABRT reporter. Example
Packit 4f15d5
fragment for /etc/libreport/report_event.conf:
Packit 4f15d5
Packit 4f15d5
------------
Packit 4f15d5
# Report Python crashes
Packit 4f15d5
EVENT=report_RHTSupport analyzer=Python
Packit 4f15d5
      reporter-rhtsupport -d . -c /etc/libreport/plugins/rhtsupport.conf
Packit 4f15d5
------------
Packit 4f15d5
Packit 4f15d5
OPTIONS
Packit 4f15d5
-------
Packit 4f15d5
-d DIR::
Packit 4f15d5
   Path to problem directory.
Packit 4f15d5
Packit 4f15d5
-c CONFFILE::
Packit 4f15d5
   Path to configuration file.
Packit 4f15d5
Packit 4f15d5
-t[ID]::
Packit 4f15d5
   Upload FILEs to the already created case on RHTSupport site.
Packit 4f15d5
Packit 4f15d5
-F CONF_FORMAT_FILE::
Packit 4f15d5
   Formatting file for a new case.
Packit 4f15d5
Packit 4f15d5
FILES
Packit 4f15d5
-----
Packit 4f15d5
/usr/share/libreport/conf.d/plugins/rhtsupport.conf::
Packit 4f15d5
    Readonly default configuration files.
Packit 4f15d5
Packit 4f15d5
/etc/libreport/plugins/rhtsupport.conf::
Packit 4f15d5
    Configuration file.
Packit 4f15d5
Packit 4f15d5
~/.config/libreport/rhtsupport.conf::
Packit 4f15d5
    User's local configuration file.
Packit 4f15d5
Packit 4f15d5
SEE ALSO
Packit 4f15d5
--------
Packit 4f15d5
abrt_event.conf(5), rhtsupport.conf(5), rhtsupport_event.conf(5)