You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
csoler be4d812df2
Merge pull request #1801 from csoler/v0.6-FT4
2 days ago
.reuse Improve license according to REUSE 3.0 2 months ago
LICENSES Improve license according to REUSE 3.0 2 months ago
build_scripts Improve debugabbility of JSON API 4 weeks ago
data Add missing categories to desktop file 1 year ago
jsonapi-generator Improve license according to REUSE 3.0 2 months ago
libbitdht/src Improve license according to REUSE 3.0 2 months ago
libretroshare/src Merge branch 'master' into v0.6-FT4 2 days ago
openpgpsdk/src Improve license according to REUSE 3.0 2 months ago
plugins moved UserNotify to MainPage level, and added RsEvent handling code in Posted 4 weeks ago
retroshare-gui/src Merge branch 'master' into v0.6-FT4 2 days ago
retroshare-service Print libretroshare version on init 1 month ago
supportlibs Drop libresapi and modules that depends on it 2 months ago
tests started removal of GxsBroadcastBase class 2 weeks ago
.gitignore Improve license according to REUSE 3.0 2 months ago
.gitmodules Drop libresapi and modules that depends on it 2 months ago
.travis.yml TravisCI MacOS disable xapian which depends on broken brew python 1 month ago
README.asciidoc README reworked 1 week ago
RetroShare.pro Improve license according to REUSE 3.0 2 months ago
appveyor.yml Improve license according to REUSE 3.0 2 months ago
retroshare.pri review fixup 2 weeks ago

README.asciidoc

// 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, 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.)