RetroShare is a Free and Open Source cross-platform, Friend-2-Friend and secure decentralised communication platform.
Find a file
csoler b556ff8fc7
Merge pull request #2959 from defnax/move-backgroundimage
Moved background image to light skin
2025-07-04 23:21:49 +02:00
.reuse Improve license according to REUSE 3.0 2019-12-18 17:57:20 +01:00
build_scripts Update macports 2025-06-14 16:21:32 +02:00
data Desktop file remove 'Application' 2025-05-31 18:28:47 +02:00
jsonapi-generator Integrate python3 JSON API generator into libretroshare 2021-12-13 18:46:56 +01:00
libbitdht@2ddc86fb57 Revert changes in libbitdht of "Merge pull request #2852 from thunder2/fix_rscollection" 2024-04-04 00:58:34 +02:00
libretroshare@ac83e00ea7 updated submodules to latest commit 2025-05-30 20:54:40 +02:00
LICENSES Improve license according to REUSE 3.0 2019-12-18 17:57:20 +01:00
openpgpsdk@178aa8ebce updated submodules to latest commit 2025-05-30 20:54:40 +02:00
plugins FeedReader: Added FontSizeHandler 2025-04-12 15:50:43 +02:00
retroshare-friendserver/src switched rs_usernp into rs_useopenpgpsdk 2024-10-22 19:25:11 +02:00
retroshare-gui Merge pull request #2959 from defnax/move-backgroundimage 2025-07-04 23:21:49 +02:00
retroshare-service Desktop file remove 'Application' 2025-05-31 18:28:47 +02:00
retroshare-webui@edfc638a6a updated master to all submodules 2024-04-02 17:55:11 +02:00
supportlibs updated submodules to latest 2025-06-05 23:22:57 +02:00
tests Moved compiler flags for warnings to retroshare.pri 2022-01-04 00:33:04 +01:00
.gitignore Update submodules and gitignore 2023-11-26 09:30:52 +01:00
.gitlab-ci.yml More attempts at fixing GitlabCI 2023-11-27 02:08:21 +01:00
.gitmodules updated submodules to latest 2025-06-05 23:22:57 +02:00
.travis.yml Disable Travis CI Linux to save scarce credits 2021-09-02 12:07:04 +02:00
appveyor.yml Re-enable creation of AppVeyor artifacts to provide nightly builds 2023-05-15 10:33:54 +02:00
COPYING Add COPYING 2020-04-01 16:35:22 +02:00
README.asciidoc Added deepwiki badge 2025-06-04 21:13:22 +02:00
retroshare.pri Merge pull request #2904 from defnax/fix-macos-v2 2025-01-19 17:41:39 +01:00
RetroShare.pro added switch to compile with rnp or openpgp-sdk 2024-08-11 16:43:20 +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.

|===============================================================================
| Developer Documentation | image:https://deepwiki.com/badge.svg[link="https://deepwiki.com/RetroShare/RetroShare",title="Ask DeepWiki"]
|===============================================================================
.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"]
|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"]
|libretroshare GNU/Linux, Android (via Gitlab CI) | image:https://gitlab.com/RetroShare/libretroshare/badges/master/pipeline.svg[link="https://gitlab.com/RetroShare/libretroshare/-/commits/master",title="pipeline status"]
|===============================================================================

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