Git-Mirrors/RetroShare
1
0
Fork 0
mirror of https://github.com/RetroShare/RetroShare.git synced 2024-12-29 01:16:20 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity
RetroShare is a Free and Open Source cross-platform, Friend-2-Friend and secure decentralised communication platform.
15,943 Commits 63 Branches 22 Tags 196 MiB
C++ 85.6%
C 7%
QMake 1.7%
HTML 1.4%
NSIS 1%
Other 3.1%
9c38eed648
Go to file
Gioacchino Mazzurco 9c38eed648
Implement deep indexing and search for forums 
RsGxsNetTunnelService::receiveSearchRequest handle no results case
  properly
RsNxsObserver::handleDistantSearchRequest improve method behaviour
  documentation
RsTurtleClientService Improve documentation
2021-10-28 09:53:48 +02:00
.reuse Improve license according to REUSE 3.0 2019-12-18 17:57:20 +01:00
build_scripts Updated OBS submodule 2021-10-27 11:47:53 +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 Implement deep indexing and search for forums 2021-10-28 09:53:48 +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 Merge pull request #2132 from sehraf/pr_add_i2p_sam3 2021-10-24 20:39:22 +02:00
retroshare-gui/src First working prototype of GXS service search 2021-10-28 09:51:29 +02:00
retroshare-service fixed bug when retroshare-service -U list is ran with no account 2021-02-20 09:32:57 +01:00
supportlibs use libsam3 git submodule 2021-03-16 21:15:31 +01:00
tests Remove a bunch of deadcode 2020-09-01 12:01:38 +02:00
.gitignore add fork of libsam3 2021-03-16 21:15:26 +01:00
.gitlab-ci.yml Improve debuggability of failed CI 2021-09-03 17:47:56 +02:00
.gitmodules use libsam3 git submodule 2021-03-16 21:15:31 +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 Implement deep indexing and search for forums 2021-10-28 09:53:48 +02:00
RetroShare.pro Enable C++14 support 2020-04-14 12:17:01 +02:00

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