-
Notifications
You must be signed in to change notification settings - Fork 73
Troubleshooting Manual
If you are reporting a security critical bug, or think that you might be, please read our Security Disclosure guide.
If you run into any issues or bugs while using ooni-probe, please follow the following instructions to submit a useful report. We love squashing bugs and we love people who take the time to report them. Thanks!
Under the section "advanced" make sure that option "debug: true" is set.
advanced:
debug: true
If the issue you want to report is reliably reproducible, clear your ooniprobe.log and reproduce the bug. This will help ensure that ooniprobe.log only contains information related to the issue you are experiencing.
You can delete the existing ooniprobe.log, or copy it to another file. e.g.
rm ooniprobe.log
or
mv ooniprobe.log ooniprobe.log.old
Alternately, you can run ooni-probe and specify a different logfile at run time by specifiying the logfile with option -l along with the rest of the commands you used. e.g.
bin/ooniprobe -l mylogfile.log blocking/http_requests -f inputfile.txt
First, you should take a look at the list of current issues and see if anyone else has already reported your issue and if there are any solutions or if you can add additional information. Otherwise, please open a new issue.
You should attach the logfile as well as a description of the issue you encountered and steps to take to reproduce the issue.
Please note that ooniprobe.log may contain sensitive information, such as your IP address, the Autonomous System Number (A unique identifier of your ISP) of the network you are connecting from, and the username and path that you are running ooni-probe from. If in doubt err on the side of caution, as all bug reports submitted through github are public and part of the development history of ooni-probe.
Note that github will require you to create an account in order to create a ticket. If you would rather not create a github account, or you believe that the issue you are reporting is security sensitive, please see the Security Disclosure and Communication pages for more information and contact details.
So you found a bug AND fixed it? Awesome! Thanks for helping out!
The github way to submit a patch is to fork the project, create a branch with your proposed changes, and submit a Pull Request with information regarding the proposed change.
If you are not familiar with github, please see the following links.
If you do not want to use github, see our Communication page.
Please see our style guide in the HACKING file.