REPORTER-UPLOAD(1)

📦
version 2.17.15 · 4 versions
, in opensuse-leap 16.0

💅 reporter-upload(1) — the LIBREPORT MANUAL, but make it cute

okay so bestie, welcome to reporter-upload 💖 this is a page from the LIBREPORT MANUAL and it's genuinely one of the handier little tools in the libreport fam, so let's get into it 🫶

✨ NAME ✨

reporter-upload — Uploads compressed tarball of problem directory. 📦✨

that's literally it. it zips up your problem dir into a compressed tarball and yeets it to a URL. iconic behaviour, no notes 💅

🌸 SYNOPSIS 🌸

reporter-upload [-c CONFFILE]... [-d DIR] [-u URL] [-b FILE] [-r FILE]

look at her. concise. efficient. main character energy 👑

🦋 DESCRIPTION 🦋

The tool is used to create a compressed tarball of the problem directory and upload it to a URL. Supported protocols include FTP, FTPS, HTTP, HTTPS, SCP, SFTP, TFTP and FILE. 🌈

like, she does the tarring and the uploading. one tool, zero chaos (well, y'know, the problem directory is already chaos, but she's not adding to it 💀).

🎀 Configuration file 🎀

Configuration file contains entries in a format "Option = Value". 📝

The options are:

  • URL — The URL where tarball should be uploaded. 🚀
  • SSHPublicKey — The SSH public key. 🔑
  • SSHPrivateKey — The SSH private key. 🔐

🧚 Integration with ABRT events 🧚

reporter-upload can be used as a reporter, to allow users to upload compressed tarballs of problem directories to a configured URL. This usage can be configured in /etc/libreport/report_event.conf:

EVENT=report_Upload reporter-upload

It can be also used on the post-create event to upload it automatically. ⚡

EVENT=post-create reporter-upload

so you can either have her hop in when someone hits report, or have her auto-run the second a problem dir is created. set it and forget it, fr fr 🫶

⭐ OPTIONS ⭐

  • -d DIR — Path to problem directory. 📁
  • -c CONFFILE — Path to configuration file. When used in ABRT event system, the file contains site-wide configuration. Users can change the values via environment variables. If not specified, it defaults to "/etc/libreport/plugins/upload.conf". 🗂️
  • -u URL — The URL where tarball should be uploaded. URL should have the form protocol://[user[:pass]@]host/dir/[file.tar.gz] where protocol can be http(s), ftp, scp, or file. File protocol can’t have user and host parts: file:///dir/[file.tar.gz]. If URL ends with a slash, the archive name will be generated and appended to URL; otherwise, URL will be used as full file name. 🌐
  • -b, --pubkey FILE — Set SSH public key file. 🔑
  • -r, --key FILE — Set SSH private key file. 🔐
ok tiny heads-up on the -u one: if your URL ends in a slash, she'll generate the archive name and stick it on the end. if there's no trailing slash, she takes the URL as the full file name. so mind your slashes, bestie 💀

💜 ENVIRONMENT VARIABLES 💜

Environment variables take precedence over values provided in the configuration file. 👑 (env vars said "i'm the main character now" and honestly? respect.)

  • Upload_URL — The URL where should be the tarball uploaded.
  • Upload_Username — User name for the upload URL
  • Upload_Password — Password for the upload URL
  • Upload_SSHPublicKey — Path to SSH public key file
  • Upload_SSHPrivateKey — Path to SSH private key file

🍓 FILES 🍓

  • /usr/share/libreport/conf.d/plugins/upload.conf — Readonly default configuration files. 📖
  • /etc/libreport/plugins/upload.conf — Configuration file. ⚙️

🔥 SEE ALSO 🔥

go read those too, iykyk 📚✨

🌸 AUTHORS 🌸

  • ABRT team 👑

aaaand that's the whole page, bestie! 💖 shoutout to the ABRT team for making her, and this lil doc-drop is LIBREPORT 2.17.15, dated 07/15/2024. go upload something iconic 🎀🦋✨

📦 where this page comes from