Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

users/stdiscosrv, users/strelaysrv: Better documentation how to obtain the binaries. #601

Merged
merged 2 commits into from
Jan 25, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions users/stdiscosrv.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,11 @@ should work in any graphical environment. At first start, stdiscosrv will
generate certificate files and database in the current directory unless
given flags to the contrary.

The discovery server can also be obtained through apt, the Debian/Ubuntu package
manager. Recent releases can be found at syncthing's
`apt repository <https://apt.syncthing.net/>`_. The name of the package is
syncthing-discosrv.

Configuring
~~~~~~~~~~~

Expand Down
17 changes: 17 additions & 0 deletions users/strelaysrv.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,23 @@ Options
Listen address for status service (blank to disable) (default ":22070").
Status service is used by the relay pool server UI for displaying stats (data transferred, number of clients, etc.)

Installing
~~~~~~~~~~

Go to `releases <https://github.com/syncthing/relaysrv/releases>`__ and
download the file appropriate for your operating system. Unpacking it will
yield a binary called ``relaysrv`` (or ``relaysrv.exe`` on Windows).
Start this in whatever way you are most comfortable with; double clicking
should work in any graphical environment. At first start, relaysrv will
generate certificate files and database in the current directory unless
given flags to the contrary. It will also join the default pools of relays,
which means that it is publicly visible and any client can connect to it.
The startup message prints instructions on how to change this.

The relay server can also be obtained through apt, the Debian/Ubuntu package
manager. Recent releases can be found at syncthing's
`apt repository <https://apt.syncthing.net/>`_. The name of the package is
syncthing-relaysrv.

Setting Up
----------
Expand Down