Skip to content

Latest commit

 

History

History
67 lines (45 loc) · 2.7 KB

README.asciidoc

File metadata and controls

67 lines (45 loc) · 2.7 KB

RetroShare

RetroShare is a decentralized, private, secure, cross-platform, communication toolkit. RetroShare provides file sharing, chat, messages, forums, channels and more.

Table 1. Build Status

GNU/Linux (via Gitlab CI)

pipeline

Windows (via AppVeyor)

RetroShare?svg=true

macOS, (via Travis CI)

RetroShare

libretroshare GNU/Linux, Android (via Gitlab CI)

pipeline

Get the source

Clone this repository, enter the directory and then get the submodules with the following command

git submodule update --init --remote --force libbitdht/ libretroshare/ openpgpsdk/

Compilation

Short of comprehensive and updated documentation on how to build RetroShare (for the many supported platforms it runs on), scripts and recipes are provided in the aim of creating packages for the supported platforms (and more) in the build_scripts directory of this repository.

Those packaging receipts together with the continuous integration files .travis.yml and appveyor.yml are a good source of knowledge on how to compile RetroShare on different platforms.

Using RetroShare on a headless computer with web UI

Warning
This section is outdated need to be adapted to the new web UI

The web UI needs to be enabled as a parameter option to the retroshare-service:

./retroshare-nogui --webinterface 9090 --docroot /usr/share/retroshare/webui/

The web UI is only accessible on localhost:9090. It is advised to keep it that way so that your RS cannot be controlled using an untrusted connection.

To access your web UI from a distance, just open a SSH tunnel to it:

distant_machine:~/ >  ssh rs_host -L 9090:localhost:9090 -N

"rs_host" is the machine running retroshare-nogui. Then on the distant machine, access your web UI on

http://localhost:9090

(This can also be done from the RetroShare GUI.)