Repository navigation
Support bundle
If you ask for help, a support bundle gives us what we need to see without you copying lines from a log by hand. It is a single .zip made on your own server, at an administrator's request. Courier makes no network call to build it and sends it nowhere: you read it, and you decide whether and where to send it.
General Settings -> Logs. The tab has a Log viewer (the latest lines of Courier's log, with credentials, names, addresses and similar details removed) and a Support bundle card with a button that downloads the .zip. Only administrators can use it.
- manifest.json -- what is in the bundle and when it was made.
- environment.txt -- the operating system and Python of the server.
- versions.txt -- the Courier version and the RSJ Agent host version it carries.
- settings.txt -- your settings, with every secret masked.
- counts.txt -- how many accounts, notices, computers and so on are held: numbers only, no names, titles or message text.
- app_log_tail.txt -- the end of the application log.
- A README that says all this, and what redaction can and cannot do.
No password, secret or token is included.
Log lines are passed through automatic redaction (addresses, accounts and device names are replaced), but that is best effort, not a guarantee: it cannot reliably remove a bare user name or a person's name. Open the .zip and look over it before you send it, and remove anything you would rather not share. If a section could not be read, its file says so and the rest of the bundle is still made.
Send it with a short description of what you were doing, in a GitHub Issue. See Troubleshooting for the other places to look first.