summaryrefslogtreecommitdiffhomepage
path: root/doc/index.mdwn
blob: 7dafc20f0997343287c29bfa4e9ed98ec37a1cdd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
[[!sidebar content="""
* [[Install]]
* [[FAQ]]
* [[News]]
* [[Bugs]]
* [[Todo]]
* [[Protocol]]
* [[Servers]]
"""]]

[[!meta title="debug-me - secure remote debugging"]]

Debugging a problem over email is slow, tedious, and hard. The developer
needs to see the your problem to understand it. Debug-me aims to make
debugging fast, fun, and easy, by letting the developer access your
computer remotely, so they can immediately see and interact with the
problem. Making your problem their problem gets it fixed fast.

A debug-me session is logged and signed with the developer's Gnupg 
key, producing a chain of evidence of what they saw and what they did. 
So the developer's good reputation is leveraged to make debug-me secure.

When you start debug-me without any options, it will connect to a debug-me
server, and print out an url that you can give to the developer to get
them connected to you. Then debug-me will show you their Gnupg key and who
has signed it. If the developer has a good reputation, you can proceed
to let them type into your console in a debug-me session. Once the
session is done, the debug-me server will email you the signed
evidence of what the developer did in the session.

It's a good idea to watch the debug-me session. The developer should be
running their buggy program in different ways, perhaps running a debugger,
or looking at configuration files. They should *not* be looking at your
personal files without asking you first in the debug-me chat window.
They should not be downloading or installing other software. If you see
them do anything you don't expect, press Control-S immediately, which
will prevent them from doing anything else. You can also press
Control-Backslash to immediately end the debug-me session.

If the developer did do something bad, you'd have proof that they cannot
be trusted, which you can share with the world. Knowing that is the case
will keep most developers honest.

----

Debug-me is free software, created by [Joey Hess](https://joeyh.name/)
and licensed under the terms of the Gnu AGPL version 3 or greater.