File a Bug

We welcome and appreciate all reports!

Overview

Our issue tracker is at https://todo.sr.ht/~arx10/furemcape. You can post new tickets or comment on existing tickets anonymously. If you register for a sourcehut account, you can also subscribe to all Furem Cape ticket updates (by clicking the “enable notifications” button on the tracker home page), or subscribe to updates for specific tickets only (by clicking the “enable notifications” button on each ticket’s page).

If the bug you’re reporting is or may expose a security vulnerability in Furem Cape (for example, a bug where Furem Cape executes code embedded in a log entry; or a bug where Furem Cape exposes log entries to unauthenticated users on a web interface; etc), instead of using the issue tracker, please report the bug to our private security email list at ~arx10/furemcape-sec@lists.sr.ht. See the Vulnerabilities page for details.

Before you post a bug report, please scan the first page of the issue tracker for recent reports, and do a quick search for the error message or behavior you’re reporting, to check if someone else has already reported the bug. If so, there’s no need to open a new ticket – but please add additional relevant info as a comment to the existing bug report (like “happens for me too, but on CentOS 8” or “I’m seeing this issue with every user whose username has a numeral in it”). Create a new ticket for each distinct bug you encounter.

When you post a new ticket, please follow this format (details in the next section):

Title Field
  • one-line summary

Description Field
  • short free-form description (optional)

  • environment

  • reproduction steps

  • actual result

  • expected result

  • workaround (optional)

  • links to related issues, log files, screenshots (optional)

Details

Put the “Title” section in the “Title” field of the ticket form, and include all other sections in the “Description” field. The “Description” field content can be as long as you need it to be. The “Description” field accepts Markdown formatting (using the basic Python Markdown flavor).

Use the following sections for your report:

Title

Write a concise, one-line summary for the bug. Use abbreviations and truncated grammar to keep it short, if necessary. It often helps to write the title last, thinking about what keywords someone else would use to try to find this bug, and what makes it unique from other bugs that might be reported.

Description

Optionally, write a one or two paragraph description of the bug, including any relevant information not found in the other sections of the bug report.

Environment

Include the version of Furem Cape you’re using, the operating system, and other relevant tools or applications (like the browser version number if it’s a bug with the web UI, or the version number of an third-party application if it’s a bug reading that application’s log entries, etc).

Reproduction Steps

List the steps it would take for someone else to reproduce the bug. Assume the other person is a five-year-old, and needs every step detailed literally.

Actual Result

Describe what happens currently when you follow the reproduction steps. Copy-and-paste the exact error message or other erroneous result that’s displayed.

Expected Result

Describe what should have happened when you followed the reproduction steps.

Workaround

Optionally, describe any tricks you’ve discovered that would help someone else who’s also encountered the bug to work around it for the time-being.

Example

Title
"missing whazzit foobar" error from reporter with top 10 IPs at danger 9
Description
Description
-----------

When I try to list the top 10 most active IP addresses via the reporter
command for danger level 9, I get a "missing whazzit foobar" error
message. This only happens for danger 9, and only with the `top`
command -- I don't get any errors with the `count` or `list` commands.

Environment
-----------

* Furem Cape 0.11.23
* Ubuntu 18.04 (Linux myhost 4.15.0-72-generic #81-Ubuntu SMP Tue Nov 26 12:20:02 UTC 2019 x86_64 x86_64 x86_64 GNU/Linux)

Repro Steps
-----------

1. log into furemcape box as a user who's a member of the `furemcape` group
2. run `furemcape-reporter top -fip -d9`

Actual Result
-------------

Error message "Error: missing whazzit foobar" printed out.

Expected Result
---------------

Top 10 most active IP address for danger level 9 printed out.

Workaround
----------

Running the `count` command with the `--unlimited` flag (eg
`furemcape-reporter count -fip -d9 -u`), and sorting the results manually,
gets you basically the same information as the `top` command would print.

Links
-----

* possibly same issue?: https://todo.example.com/~arx10/furemcape/123
* related log files: https://pastebin.example.com/ABC123

Feature Requests

Please follow the same general format as above for feature requests. Use the “Reproduction Steps” section to describe how someone would invoke the feature, the “Actual Result” to describe what happens today, the “Expected Result” to describe what you’d like to happen, and the “Workaround” to describe what you have to do currently to work around not having the feature.