RetroShare is a Free and Open Source cross-platform, Friend-2-Friend and secure decentralised communication platform.
Go to file
Gioacchino Mazzurco e850e00a82
Optimization, cleanup, compiler warning fix
Chores I have made while working on single file share
2021-07-19 16:40:13 +02:00
.reuse Improve license according to REUSE 3.0 2019-12-18 17:57:20 +01:00
build_scripts Merge pull request #2402 from defnax/macos 2021-04-03 14:19:04 +02:00
data Add missing categories to desktop file 2019-02-05 15:02:15 +01:00
jsonapi-generator fid typo in JSON API README 2021-02-01 16:09:56 +01:00
libbitdht/src Update bdboot.txt 2021-01-05 21:46:42 +01:00
libretroshare/src Optimization, cleanup, compiler warning fix 2021-07-19 16:40:13 +02:00
LICENSES Improve license according to REUSE 3.0 2019-12-18 17:57:20 +01:00
openpgpsdk/src Merge remote-tracking branch 'remotes/retroshare/master' into feature/msys2enhancements 2020-06-19 22:48:43 +02:00
plugins fixed VOIP compilation on ubuntu 20.04 2021-04-04 14:40:15 +02:00
retroshare-gui/src fix smiley bug 2021-06-10 00:41:42 +03:00
retroshare-service fixed bug when retroshare-service -U list is ran with no account 2021-02-20 09:32:57 +01:00
supportlibs Drop libresapi and modules that depends on it 2019-11-27 23:32:38 +01:00
tests Remove a bunch of deadcode 2020-09-01 12:01:38 +02:00
.gitignore Improve license according to REUSE 3.0 2019-12-18 17:57:20 +01:00
.gitlab-ci.yml GitlabCI specify repo url and branch also without merge request 2020-04-20 15:52:30 +02:00
.gitmodules Drop libresapi and modules that depends on it 2019-11-27 23:32:38 +01:00
.travis.yml attempt to fix 2021-03-14 00:47:57 +01:00
appveyor.yml Fix Appveyor Windows build failing 2020-10-31 16:27:54 +03:30
COPYING Add COPYING 2020-04-01 16:35:22 +02:00
README.asciidoc Add Gitlab CI build status 2020-04-08 12:10:06 +02:00
retroshare.pri Fix libupnp autodetection for qmake 2021-04-25 23:38:00 +03:00
RetroShare.pro Enable C++14 support 2020-04-14 12:17:01 +02:00

// SPDX-FileCopyrightText: Retroshare Team <contact@retroshare.cc>
// SPDX-License-Identifier: CC-BY-SA-4.0

= RetroShare

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

.Build Status
|===============================================================================
|GNU/Linux (via Gitlab CI) | image:https://gitlab.com/RetroShare/RetroShare/badges/master/pipeline.svg[link="https://gitlab.com/RetroShare/RetroShare/-/commits/master",title="pipeline 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

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:

[source,bash]
--------
./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:

[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 web UI on 


      http://localhost:9090

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