RetroShare is a Free and Open Source cross-platform, Friend-2-Friend and secure decentralised communication platform.
Go to file
2019-12-18 13:08:22 +01:00
build_scripts Use SPDX standard names for licenses 2019-12-18 13:08:22 +01:00
data Add missing categories to desktop file 2019-02-05 15:02:15 +01:00
jsonapi-generator Prepare for merging 2019-11-27 18:44:10 +01:00
libbitdht/src added compile option to use sanitizer and already fixed a few misalignment errors with it 2019-05-11 22:25:02 +02:00
libretroshare/src Fix Android compilation 2019-12-11 01:25:14 +01:00
LICENSES Use SPDX standard names for licenses 2019-12-18 13:08:22 +01:00
openpgpsdk/src moved qmake files in openpgpsdk to Apache-2.0 2018-11-11 14:24:49 +01:00
plugins little changes 2019-11-25 23:06:04 +01:00
retroshare-gui/src improved Topics details view 2019-12-11 13:54:26 +01:00
retroshare-service removed duplicate call to StartupRetroshare 2019-12-02 13:14:18 +00:00
supportlibs Drop libresapi and modules that depends on it 2019-11-27 23:32:38 +01:00
tests fixed retroshare.project email in licenses 2018-11-11 20:42:48 +01:00
.gitignore Prepare for merging 2019-11-27 18:44:10 +01:00
.gitmodules Drop libresapi and modules that depends on it 2019-11-27 23:32:38 +01:00
.travis.yml TavisCI OSX add miniupnpc include and lib path 2019-11-28 16:01:47 +01:00
appveyor.yml Appveyor remove abandoned libresapi libraries deploy 2019-11-28 20:55:47 +01:00
README.asciidoc Fix windows compile due to rsversion JSON API 2019-11-28 17:41:03 +01:00
retroshare.pri Fix Android compilation 2019-12-11 01:25:14 +01:00
RetroShare.pro Cleanup qmake files, Appveyor list produced files 2019-11-28 19:03:55 +01:00

= RetroShare

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

.Build Status
|===============================================================================
|GNU/Linux, MacOS, (via travis-ci) | image:https://travis-ci.org/RetroShare/RetroShare.svg?branch=master[link="https://travis-ci.org/RetroShare/RetroShare"]
|Windows (via appveyor) | image:https://ci.appveyor.com/api/projects/status/github/RetroShare/RetroShare?svg=true[link="https://ci.appveyor.com/project/RetroShare58622/retroshare"]
|===============================================================================


== Compilation

It is very difficult to keep a comprehensive (we support many platforms) and
updated documentation on how to build RetroShare, instead we provide scripts and
recipes that are used to create the 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 WebUI

WARNING: This section is outdated need to be adapted to new WebUI

The webUI needs to be enabled as a parameter option in retroshare-service:

[source,bash]
--------
./retroshare-nogui --webinterface 9090 --docroot /usr/share/retroshare/webui/
--------

The webUI 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 on it:

[source,bash]
--------
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 webUI on 


      http://localhost:9090

That also works with a retroshare GUI of course.