RetroShare is a Free and Open Source cross-platform, Friend-2-Friend and secure decentralised communication platform.
Go to file
G10h4ck 5be7869304
Merge pull request #2522 from G10h4ck/cmake_build
Add support to build via CMake
2021-12-09 17:50:30 +01:00
.reuse Improve license according to REUSE 3.0 2019-12-18 17:57:20 +01:00
build_scripts Rename DATA_DIR macro to less polluting RS_DATA_DIR 2021-12-09 12:56:48 +01: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 Initial CMake support for libretroshare 2021-12-09 13:04:06 +01:00
libretroshare Initial CMake support for libretroshare 2021-12-09 13:04:06 +01:00
LICENSES Improve license according to REUSE 3.0 2019-12-18 17:57:20 +01:00
openpgpsdk Initial CMake support for libretroshare 2021-12-09 13:04:06 +01:00
plugins Remove unused skins. 2021-11-29 15:39:42 +01:00
retroshare-gui/src Fixed to display the right index for Image Page 2021-12-04 12:12:29 +01:00
retroshare-service Do not depend on Qt at all on Android 2021-11-30 11:55:15 +01:00
supportlibs Do not depend on Qt at all on Android 2021-11-30 11:55:15 +01:00
tests Improve JSON API DirDetails handle type test 2021-11-04 13:29:32 +01:00
.gitignore add fork of libsam3 2021-03-16 21:15:26 +01:00
.gitlab-ci.yml Gitlab CI Android improve configurability 2021-11-10 10:52:18 +01:00
.gitmodules Do not depend on Qt at all on Android 2021-11-30 11:55:15 +01:00
.travis.yml Disable Travis CI Linux to save scarce credits 2021-09-02 12:07:04 +02: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 Disable Travis CI Linux to save scarce credits 2021-09-02 12:07:04 +02:00
retroshare.pri Rename DATA_DIR macro to less polluting RS_DATA_DIR 2021-12-09 12:56:48 +01: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, Android (via Gitlab CI) | image:https://gitlab.com/RetroShare/RetroShare/badges/master/pipeline.svg[link="https://gitlab.com/RetroShare/RetroShare/-/commits/master",title="pipeline status"]
|Windows (via AppVeyor) | image:https://ci.appveyor.com/api/projects/status/github/RetroShare/RetroShare?svg=true[link="https://ci.appveyor.com/project/RetroShare58622/retroshare"]
|macOS, (via Travis CI) | image:https://app.travis-ci.com/RetroShare/RetroShare.svg?branch=master[link="https://app.travis-ci.com/github/RetroShare/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.)