Skip to content

Support Bundle

github-actions[bot] edited this page Nov 17, 2026 · 1 revision

Support Bundle

If you ask for help, a support bundle gives us what we need to see without you copying lines out of a log by hand. It is a single .zip made on your own server at an administrator's request. Groundskeeper sends it nowhere: you look at it, and you decide whether and where to send it.

Where to find it

General Settings -> Logs. The tab has a Live log viewer (the latest lines of Groundskeeper's log, which you can filter by source and level, pause, or download) and a Support bundle card. Choose Collect logs for support and the .zip downloads to the computer you are using. Only administrators can do this.

What is in it

  • README.txt -- what is in the bundle, and what the automatic redaction can and cannot do.
  • manifest.json -- what the bundle holds and when it was made, with your installation's ID.
  • environment.txt -- a summary of the server: Windows, Python, memory, and whether Windows encryption of saved passwords (DPAPI) is available.
  • connectors.txt -- your connectors and how their last check went. No passwords or keys.
  • feed_events.txt -- the most recent 200 Dashboard events.
  • agents.txt -- how many computers run the agent, as numbers only: no computer names and nothing about any one computer.
  • app_log_tail.txt -- the end of today's application log.

No password, key or token from your settings is included.

Please look at it first

Event text and log lines go through automatic redaction (addresses, email addresses and device names are replaced with markers such as [IP_ADDRESS] and [DEVICE]), but that is best effort, not a guarantee. It cannot reliably remove a bare user name, a person's name, or a computer name that does not follow a usual pattern. Open the .zip and look over it before you send it, and take out anything you would rather not share.

Sending it

Attach it to a post in Groundskeeper's Discussions or to a support email, with a short description of what you were doing. Quoting the installation ID from manifest.json helps us find your record. See Troubleshooting for the things to check first.

Last updated: 2026-11-16 (v0.196.14)

Clone this wiki locally