summaryrefslogtreecommitdiff
path: root/FAQ.md
diff options
context:
space:
mode:
Diffstat (limited to 'FAQ.md')
-rw-r--r--FAQ.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/FAQ.md b/FAQ.md
new file mode 100644
index 0000000..b25685d
--- /dev/null
+++ b/FAQ.md
@@ -0,0 +1,46 @@
1## How to report crash issues?
2
3* [Learn to use GDB](https://wiki.ubuntu.com/Backtrace#Generation) (or see [Arch Wiki](https://wiki.archlinux.org/index.php/Debug_-_Getting_Traces#Getting_the_trace) if you can't stand seeing the Ubuntu logo)
4* Preferably, [build tuntox and c-toxcore from source](BUILD.md)
5* run tuntox with `-d -d -d` switch (yes, three times) on both sides (client and server)
6* Try reproducing the problem
7* Type `backtrace full` in gdb console when it crashes
8* Paste full debug output including gdb output in your issue. Don't forget to paste log from the other side (eg. from a client when you're reporting a server crash).
9* Describe exactly how you reproduced the problem. Preferably try reproducing it again.
10
11## How to report non-crash issues?
12
13* Make sure you're running the latest version
14* run tuntox with `-d -d -d` switch (yes, three times):
15
16```
17tuntox -d -d -d -i ABDE4CF4541C27DBE36A812FF6752F71A9F44D1CF917CE489B30CC3D742500039B86C14F85F9
18```
19
20* Try reproducing the problem and note approximate date/time of the problem, so that logs can be cross-referenced
21* Depending on the nature of the problem, logs from both server and client may be needed
22* Describe exactly how you reproduced the problem. Preferably try reproducing it again.
23
24## Why is my connection slow?
25
26The actual p2p connection is made by the [c-toxcore](https://github.com/TokTok/c-toxcore) library. The way it works is: it tries to establish a direct connection between peers and falls back to [TCP relays](https://nodes.tox.chat/) if that's impossible.
27
28The direct connection code doesn't see much work and c-toxcore sometimes uses a TCP relay even when both peers have a public IP address and can reach each other directly.
29
30Also please note that sometimes the connection improves after a few minutes as the peers discover each other.
31
32You're going to get the best connection if you see the following message on the client:
33
34```
352018-03-24 08:59:21: [INFO] Friend request accepted (An UDP connection has been established)!
36```
37
38The connection is likely to have worse latency when you see the following:
39
40```
412018-03-24 08:57:21: [INFO] Friend request accepted (A TCP connection has been established (via TCP relay))!
42```
43
44## I have a direct UDP connection. Why isn't my connection faster?
45
46Wait until https://github.com/gjedeer/tuntox/issues/41 is implemented. This change should improve speed and latency in the 10 Mbit/s+ range.