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
48
49
50
51
52
53
54
55
56
57
58
59
60
|
.. We register the :strike: role for strikethrough text. Use it like
.. :strike:`this is struck out`.
.. role:: strike
Welcome to Syncthing's documentation!
=====================================
As a new user, the :ref:`getting started guide <getting-started>` is a good
place to start, then perhaps moving on to :ref:`the FAQ <faq>`. If you run
into trouble getting devices to connect to each other, the page about
:ref:`firewall setup <firewall-setup>` explains the networking necessary to
get it to work.
As a developer looking to get started with a contribution, see :ref:`how to
build <building>`, :ref:`how to debug <debugging>` and the `contribution
guidelines`_. This documentation site can be edited on GitHub_.
Contact
-------
* If you're looking for specific people to talk to, check out the
:ref:`project-presentation`.
* To report bugs or request features, please use the `issue tracker`_. Before you
do so, make sure you are running the `latest version`_, and please do a
quick search to see if the issue has already been reported.
.. image:: issues.png
* To report security issues, please follow the instructions on the
`Security page`_.
* To get help and support, discuss scenarios, or just connect with other
users and developers you can head over to the `friendly forum`_.
* For other concerns you may reach out to members of the maintainers, currently
:user:`calmh`, :user:`AudriusButkevicius` and :user:`imsodin`.
.. toctree::
:maxdepth: 2
:includehidden:
intro/index
users/index
dev/index
specs/index
Thanks
------
We thank all the documentation contributors for their hard work:
.. include:: thanks.txt
.. _`contribution guidelines`: https://github.com/syncthing/syncthing/blob/main/CONTRIBUTING.md
.. _GitHub: https://github.com/syncthing/docs
.. _`issue tracker`: https://github.com/syncthing/syncthing/issues
.. _`latest version`: https://github.com/syncthing/syncthing/releases/latest
.. _`Security page`: https://syncthing.net/security
.. _`friendly forum`: https://forum.syncthing.net
|
