Git-Mirrors/RetroShare
1
0
Fork 0
mirror of https://github.com/RetroShare/RetroShare.git synced 2024-12-27 16:39:29 -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,361 Commits 63 Branches 22 Tags 196 MiB
C++ 85.6%
C 7%
QMake 1.7%
HTML 1.4%
NSIS 1%
Other 3.1%
a177d456a1
Go to file
defnax a177d456a1 More wire ui fixes 
* Added a Top Avatar Label when its a new Post.
* Hide Top Avatar on replies
* Wire stylesheet fixes.
* Fixed place holder text cleanup
2020-12-29 23:43:24 +01:00
.reuse Improve license according to REUSE 3.0 2019-12-18 17:57:20 +01:00
build_scripts Windows build environment 2020-11-30 11:39:27 +01:00
data Add missing categories to desktop file 2019-02-05 15:02:15 +01:00
jsonapi-generator Fix a few compiler warnings 2020-04-14 12:17:02 +02:00
libbitdht/src Update bdbood.txt plus add a script to keep it fresh 2020-08-31 21:56:58 +02:00
libretroshare/src Merge pull request #2168 from PhenomRetroShare/Fix_SystemMessageSender 2020-12-20 15:44:38 +01: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 updated translation files 2020-12-10 09:37:10 +01:00
retroshare-gui/src More wire ui fixes 2020-12-29 23:43:24 +01:00
retroshare-service Merge remote-tracking branch 'remotes/retroshare/master' into feature/msys2enhancements 2020-06-19 22:48:43 +02:00
supportlibs Drop libresapi and modules that depends on it 2019-11-27 23:32:38 +01:00
tests Remove a bunch of deadcode 2020-09-01 12:01:38 +02:00
.gitignore Improve license according to REUSE 3.0 2019-12-18 17:57:20 +01:00
.gitlab-ci.yml GitlabCI specify repo url and branch also without merge request 2020-04-20 15:52:30 +02:00
.gitmodules Drop libresapi and modules that depends on it 2019-11-27 23:32:38 +01:00
.travis.yml Specify C++ version inn travis macosx 2020-06-29 17:26:45 +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 Add Gitlab CI build status 2020-04-08 12:10:06 +02:00
retroshare.pri Fix RsMutex Debug and add rs_mutex_debug qmake option. 2020-12-08 17:15:16 +01: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 (via Gitlab CI) | image:https://gitlab.com/RetroShare/RetroShare/badges/master/pipeline.svg[link="https://gitlab.com/RetroShare/RetroShare/-/commits/master",title="pipeline 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.)