Git-Mirrors/RetroShare
1
0
Fork 0
mirror of https://github.com/RetroShare/RetroShare.git synced 2024-12-27 00:19:25 -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.
14,219 Commits 63 Branches 22 Tags 196 MiB
C++ 85.6%
C 7%
QMake 1.7%
HTML 1.4%
NSIS 1%
Other 3.1%
d203f31d0c
Go to file
Gioacchino Mazzurco d203f31d0c
Improve files links generation parsing and errors 
Implement URL safe base64 for file links
Implement sneaking file data into URL fragment
Deprecate Radix65 in favore of RsBase64 which supports also URL safe encoding
2020-04-14 12:17:01 +02:00
.reuse Improve license according to REUSE 3.0 2019-12-18 17:57:20 +01:00
build_scripts GitlabCI install jq in outer docker image where it is executed 2020-04-08 12:10:06 +02:00
data Add missing categories to desktop file 2019-02-05 15:02:15 +01:00
jsonapi-generator Improve license according to REUSE 3.0 2019-12-18 17:57:20 +01:00
libbitdht/src Improve license according to REUSE 3.0 2019-12-18 17:57:20 +01:00
libretroshare/src Improve files links generation parsing and errors 2020-04-14 12:17:01 +02:00
LICENSES Improve license according to REUSE 3.0 2019-12-18 17:57:20 +01:00
openpgpsdk/src Improve license according to REUSE 3.0 2019-12-18 17:57:20 +01:00
plugins removed unused print methods in some RsItems since now print is handled by serializer 2020-02-29 12:14:37 +01:00
retroshare-gui/src Initial work on RsFiles links support in libretroshare 2020-04-14 12:17:01 +02:00
retroshare-service Print libretroshare version on init 2020-01-07 01:18:29 +01:00
supportlibs Drop libresapi and modules that depends on it 2019-11-27 23:32:38 +01:00
tests removed askForDeferredSelfSignature() and made IdEditDialog comply with this 2020-04-02 22:24:14 +02:00
.gitignore Improve license according to REUSE 3.0 2019-12-18 17:57:20 +01:00
.gitlab-ci.yml GitlabCI fix typo in test 2020-04-08 12:10:07 +02:00
.gitmodules Drop libresapi and modules that depends on it 2019-11-27 23:32:38 +01:00
.travis.yml TravisCI MacOS disable xapian which depends on broken brew python 2020-01-07 11:37:06 +01:00
appveyor.yml Improve license according to REUSE 3.0 2019-12-18 17:57:20 +01:00
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 Add option to disable DH init check for faster init 2020-03-03 16:21:14 +01:00
RetroShare.pro Improve license according to REUSE 3.0 2019-12-18 17:57:20 +01: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.)