RetroShare is a Free and Open Source cross-platform, Friend-2-Friend and secure decentralised communication platform.
Go to file
thunder2 f125539d79 Added new parameter for Windows MinGW build
- Service
- Friend Server
- embedded Friend Server
2022-02-02 18:11:00 +01:00
.reuse Improve license according to REUSE 3.0 2019-12-18 17:57:20 +01:00
build_scripts Added new parameter for Windows MinGW build 2022-02-02 18:11:00 +01:00
data Add missing categories to desktop file 2019-02-05 15:02:15 +01:00
jsonapi-generator Integrate python3 JSON API generator into libretroshare 2021-12-13 18:46:56 +01:00
libbitdht@6594237695 Update submodules and README 2022-01-11 12:49:18 +01:00
libretroshare@55efaf9c73 fixed using of rs_socket_error() 2022-01-31 15:32:04 +01:00
LICENSES Improve license according to REUSE 3.0 2019-12-18 17:57:20 +01:00
openpgpsdk@b416679127 Update submodules and README 2022-01-11 12:49:18 +01:00
plugins Merge pull request #2545 from thunder2/warnings 2022-01-08 17:53:06 +01:00
retroshare-friendserver/src Merge pull request #2576 from hunbernd/fix/msys2-2 2022-02-01 12:53:35 +01:00
retroshare-gui/src fixed the notification icon 2022-01-28 20:56:06 +01:00
retroshare-service Friendserver support 2022-01-31 16:30:55 +01:00
supportlibs Do not depend on Qt at all on Android 2021-11-30 11:55:15 +01:00
tests Moved compiler flags for warnings to retroshare.pri 2022-01-04 00:33:04 +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 Split libretroshare BitDHT and OpenPGP-SDK into submodules 2022-01-10 21:37:03 +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 Update submodules and README 2022-01-11 12:49:18 +01:00
retroshare.pri Merge pull request #2495 from csoler/v0.6-FriendServer 2022-01-10 20:14:58 +01:00
RetroShare.pro added base network layer for friend server. Not working yet. 2021-10-09 01:08:23 +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"]
|===============================================================================

== Get the source

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

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

[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.)