mailinabox
mailinabox copied to clipboard
Collecting a debug log to aid in support requests.
This PR adds one package: gist-paste and one shell script to MIAB.
The goal of this PR is to provide a tool for users to collect all of the pertinent diagnostic information for their MIAB installation in one log file and then optionally post that log to https://gist.github.com as a 'secret' gist.
Please see #1068 for more information.
I feel like this is ready for prime time, if we feel comfortable with the warnings and GitHub login process.
Being unfamiliar with the EU privacy concerns, it might make sense for @yodax to chime in on the appropriate language for posting the debug log.
pinging to see if there are any thoughts?
Pinging again to see if we can merge this in.
-
Naive users (who are the users this helps the most) may be scared by all of this. What's gist.github.com? Do I have a username and where would I get one? How do I know if it's safe to post this information? What's a debug log file? How can I see the debug log file? How would I copy it into the forum?
-
In the discussion forum, the main bits of server information that seem important to many questions are the IP addresses, domain names, and mail log. I'm not sure if some of the commands produce information that would be helpful for diagnosing problems that come up.
-
For naive users, perhaps instead of posting to gist.github.com, we simply place the log in /tmp with links to common gist-like sites? I fear the process of sharing hundreds of lines of logfile with those who might be able to help will be challenging at best for naive users on the command line. It's a tradeoff.
-
I went through as many of the resolved issues on Github and discourse to try to put together a list of the most valuable pieces of info for resolving issues. The log pulls all domains, IP addresses, firewall rules, mail log, etc. It's pretty comprehensive, but I'm happy to add/remove.