Git-Mirrors/RetroShare
1
0
Fork 0
mirror of https://github.com/RetroShare/RetroShare.git synced 2024-10-01 02:35:48 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #1791 from comradekingu/patch-1

Browse Source 
README reworked
This commit is contained in:
csoler 2020-02-15 13:41:32 +01:00 committed by GitHub
commit ae77420990
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.asciidoc
View File

@ -5,51 +5,51 @@
RetroShare is a decentralized, private, secure, cross-platform, communication RetroShare is a decentralized, private, secure, cross-platform, communication
toolkit. toolkit.
RetroShare provides filesharing, chat, messages, forums, channels and more. RetroShare provides file sharing, chat, messages, forums, channels and more.
.Build Status .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"] |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"] |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 == Compilation
It is very difficult to keep a comprehensive (we support many platforms) and Short of comprehensive and updated documentation on how to build RetroShare
updated documentation on how to build RetroShare, instead we provide scripts and (for the many supported platforms it runs on), scripts and recipes are provided
recipes that are used to create the packages for the supported platforms and in the aim of creating packages for the supported platforms (and more)
more in the `build_scripts` directory of this repository. in the `build_scripts` directory of this repository.
Those packaging receipts together with the continuous integration files Those packaging receipts together with the continuous integration files
`.travis.yml` and `appveyor.yml` are a good source of knowledge on how to `.travis.yml` and `appveyor.yml` are a good source of knowledge on how to
compile RetroShare on different platforms. compile RetroShare on different platforms.
== Using RetroShare on a headless computer with WebUI == Using RetroShare on a headless computer with web UI
WARNING: This section is outdated need to be adapted to new WebUI WARNING: This section is outdated need to be adapted to the new web UI
The webUI needs to be enabled as a parameter option in retroshare-service: The web UI needs to be enabled as a parameter option to the retroshare-service:
[source,bash] [source,bash]
-------- --------
./retroshare-nogui --webinterface 9090 --docroot /usr/share/retroshare/webui/ ./retroshare-nogui --webinterface 9090 --docroot /usr/share/retroshare/webui/
-------- --------
The webUI is only accessible on localhost:9090. It is advised to keep it that way so that your RS 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. cannot be controlled using an untrusted connection.
To access your web UI from a distance, just open a SSH tunnel on it: To access your web UI from a distance, just open a SSH tunnel to it:
[source,bash] [source,bash]
-------- --------
distant_machine:~/ > ssh rs_host -L 9090:localhost:9090 -N 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 webUI on "rs_host" is the machine running `retroshare-nogui`. Then on the distant machine, access your web UI on
http://localhost:9090 http://localhost:9090
That also works with a retroshare GUI of course. (This can also be done from the RetroShare GUI.)