report_a_bug.mdwn 3.93 KB
Newer Older
1
[[!meta title="Report a bug"]]
2

3
Reporting bugs is a great way of helping us improving Tails.
4

5 6
Remember that **the more effectively you report a bug**, the more likely we are
to fix it.
7

8 9
[[!toc levels=2]]

10 11
Check if the bug is already known
=================================
12

13
Have a look at:
14

15 16
- the [[list of known bugs|bugs]]
- the [[list of bugs that will fixed in the next release|bugs/pending]]
17 18 19 20

How to write a useful bug report
================================

21 22 23 24 25 26 27 28 29
Please read at least the _Summary_ section of the great [How to Report Bugs
Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html#summary), by
Simon Tatham.

Use WhisperBack
===============

**WhisperBack is an application written specifically to report bugs anonymously
from inside Tails. If you are not able to use WhisperBack, see the [[special
30
cases|report_a_bug#index4h1]].**
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60

WhisperBack will help you fill-up a bug report, including relevant technical
details and send it to us encrypted and through Tor.

Starting WhisperBack
--------------------

You will find a shortcut to start WhisperBack on the desktop:

[[!img report_a_bug.png link=no alt="Report a Bug shortcut on the desktop"]]

You can also start it from the menu *Applications* → *System Tools* →
*WhisperBack*.

Write the report
----------------

WhisperBack let you give plenty of useful information about your bug:

- **Summary** a summary of the bug, try to be short, clear and informative
- **Name of the affected software**
- **Exact steps to reproduce the problem**
- **Actual result / the problem**
- **Desired result**

[[!img whisperback.png link=no alt="WhisperBack main window"]]

You can also have a look at the technical details that will be included in the
mail. It will give us information about your hardware, your Tails version and
the startup process.
61

62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
[[!img technical_details.png link=no alt="Technical details at the bottom of the
main window"]]

About giving us an email address
--------------------------------

If you don't mind disclosing some bits of your identity to Tails developers, you
can provide an email address to let us ask more details about the bug.

Anyone who can see this reply will probably infer you are a Tails user. Time to
wonder how much you trust your Internet and mailbox providers?

Optional OpenPGP key
--------------------

You can also indicate an OpenPGP key corresponding to this email address. You
can either give:

- a **key ID**, if the key is available on public key servers
- a **link to the key**, if the key is available on the web
- a **public key block**, if the key is not publicly available

Sending your report
-------------------

Once you are done writing your report, send it by clicking the *Send* button.

[[!img sending_email.png link=no alt="Sending email"]]

Once your email has been sent correctly you will get the following notification.

[[!img your_message_has_been_sent.png link=no alt="Your message has been sent"]]
94 95 96 97

Special cases
=============

98 99
You might not always be able to use WhisperBack. In those cases, you can also
send you bug report by [[email|support/talk]].
100

101 102
Note that if you send the report yourself, it might not be anonymous unless you
take special care (e.g. using Tor with a throw-away email account).
103

104 105 106 107 108 109 110 111 112
Tails does not boot entirely
----------------------------

1. In the graphical boot menu, press `TAB`
2. Add the `debug` parameter to the boot command line
3. Remove all appearance of the `quiet` parameter

This will hopefully display a bunch of useful messages on boot that you can
later include in your bug report.
113 114 115 116

No internet access
------------------

117 118 119
WhisperBack won't be able to send your bug report.

The following steps can be used as a workaround.
120

121
1. In Tails, start WhisperBack
122 123 124
2. In the bug report window, expand "technical details to include"
3. Copy everything in the "debugging info" box
4. Paste it to another document (using gedit for instance)
125 126
5. Save the document on a USB stick
6. Boot into a system with Internet connection and send your report