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
9210e52aae
RetroShare/README.asciidoc

68 lines
2.7 KiB
Plaintext
Raw Normal View History

Improve license according to REUSE 3.0 FSFE licensing checking program lint is now happy $ reuse lint * Bad licenses: * Missing licenses: * Unused licenses: * Used licenses: AGPL-3.0-only, AGPL-3.0-or-later, Apache-2.0, CC-BY-SA-4.0, CC0-1.0, GPL-3.0-or-later, LGPL-3.0-or-later, MIT * Read errors: 0 * Files with copyright information: 6324 / 6324 * Files with license information: 6324 / 6324 Congratulations! Your project is compliant with version 3.0 of the REUSE Specification :-)
2019-12-18 11:57:20 -05:00
// SPDX-FileCopyrightText: Retroshare Team <contact@retroshare.cc>
// SPDX-License-Identifier: CC-BY-SA-4.0
Drop libresapi and modules that depends on it A copy of the repository freezed before this deletion to ease old code viewing is available at https://github.com/RetroShare/zz_archive_RetroShare_libresapi Removed some more cruft Temporarly disabled JSON API generation of RsWebUi methods due to compilation breakage when rs_webui is disabled, RsWebUi keeps working but cannot be restarted from JSON API
2019-11-27 17:32:38 -05:00
= RetroShare
RetroShare is a decentralized, private, secure, cross-platform, communication
toolkit.
README reworked
2020-02-12 19:46:51 -05:00
RetroShare provides file sharing, chat, messages, forums, channels and more.
Drop libresapi and modules that depends on it A copy of the repository freezed before this deletion to ease old code viewing is available at https://github.com/RetroShare/zz_archive_RetroShare_libresapi Removed some more cruft Temporarly disabled JSON API generation of RsWebUi methods due to compilation breakage when rs_webui is disabled, RsWebUi keeps working but cannot be restarted from JSON API
2019-11-27 17:32:38 -05:00
.Build Status
|===============================================================================
Update continuous integration
2022-02-25 10:57:07 -05:00
|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"]
README reworked
2020-02-12 19:46:51 -05:00
|Windows (via AppVeyor) | image:https://ci.appveyor.com/api/projects/status/github/RetroShare/RetroShare?svg=true[link="https://ci.appveyor.com/project/RetroShare58622/retroshare"]
Disable Travis CI Linux to save scarce credits Fix Travis CI badge URL
2021-09-02 06:07:04 -04:00
|macOS, (via Travis CI) | image:https://app.travis-ci.com/RetroShare/RetroShare.svg?branch=master[link="https://app.travis-ci.com/github/RetroShare/RetroShare"]
Update continuous integration
2022-02-25 10:57:07 -05:00
|libretroshare GNU/Linux, Android (via Gitlab CI) | image:https://gitlab.com/RetroShare/libretroshare/badges/master/pipeline.svg[link="https://gitlab.com/RetroShare/libretroshare/-/commits/master",title="pipeline status"]
Drop libresapi and modules that depends on it A copy of the repository freezed before this deletion to ease old code viewing is available at https://github.com/RetroShare/zz_archive_RetroShare_libresapi Removed some more cruft Temporarly disabled JSON API generation of RsWebUi methods due to compilation breakage when rs_webui is disabled, RsWebUi keeps working but cannot be restarted from JSON API
2019-11-27 17:32:38 -05:00
|===============================================================================
Added istructions on how to get the submodules
2022-01-10 15:59:39 -05:00
== Get the source
Clone this repository, enter the directory and then get the submodules with the
following command
[source,bash]
--------
Update submodules and README
2022-01-11 06:49:18 -05:00
git submodule update --init --remote --force libbitdht/ libretroshare/ openpgpsdk/
Added istructions on how to get the submodules
2022-01-10 15:59:39 -05:00
--------
Drop libresapi and modules that depends on it A copy of the repository freezed before this deletion to ease old code viewing is available at https://github.com/RetroShare/zz_archive_RetroShare_libresapi Removed some more cruft Temporarly disabled JSON API generation of RsWebUi methods due to compilation breakage when rs_webui is disabled, RsWebUi keeps working but cannot be restarted from JSON API
2019-11-27 17:32:38 -05:00
== Compilation
README reworked
2020-02-12 19:46:51 -05:00
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.
Drop libresapi and modules that depends on it A copy of the repository freezed before this deletion to ease old code viewing is available at https://github.com/RetroShare/zz_archive_RetroShare_libresapi Removed some more cruft Temporarly disabled JSON API generation of RsWebUi methods due to compilation breakage when rs_webui is disabled, RsWebUi keeps working but cannot be restarted from JSON API
2019-11-27 17:32:38 -05:00
Fix windows compile due to rsversion JSON API
2019-11-28 10:29:10 -05:00
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.
TavisCI OSX add miniupnpc include and lib path
2019-11-28 09:48:17 -05:00
Drop libresapi and modules that depends on it A copy of the repository freezed before this deletion to ease old code viewing is available at https://github.com/RetroShare/zz_archive_RetroShare_libresapi Removed some more cruft Temporarly disabled JSON API generation of RsWebUi methods due to compilation breakage when rs_webui is disabled, RsWebUi keeps working but cannot be restarted from JSON API
2019-11-27 17:32:38 -05:00
README reworked
2020-02-12 19:46:51 -05:00
== Using RetroShare on a headless computer with web UI
Drop libresapi and modules that depends on it A copy of the repository freezed before this deletion to ease old code viewing is available at https://github.com/RetroShare/zz_archive_RetroShare_libresapi Removed some more cruft Temporarly disabled JSON API generation of RsWebUi methods due to compilation breakage when rs_webui is disabled, RsWebUi keeps working but cannot be restarted from JSON API
2019-11-27 17:32:38 -05:00
README reworked
2020-02-12 19:46:51 -05:00
WARNING: This section is outdated need to be adapted to the new web UI
Drop libresapi and modules that depends on it A copy of the repository freezed before this deletion to ease old code viewing is available at https://github.com/RetroShare/zz_archive_RetroShare_libresapi Removed some more cruft Temporarly disabled JSON API generation of RsWebUi methods due to compilation breakage when rs_webui is disabled, RsWebUi keeps working but cannot be restarted from JSON API
2019-11-27 17:32:38 -05:00
README reworked
2020-02-12 19:46:51 -05:00
The web UI needs to be enabled as a parameter option to the retroshare-service:
Drop libresapi and modules that depends on it A copy of the repository freezed before this deletion to ease old code viewing is available at https://github.com/RetroShare/zz_archive_RetroShare_libresapi Removed some more cruft Temporarly disabled JSON API generation of RsWebUi methods due to compilation breakage when rs_webui is disabled, RsWebUi keeps working but cannot be restarted from JSON API
2019-11-27 17:32:38 -05:00
[source,bash]
--------
./retroshare-nogui --webinterface 9090 --docroot /usr/share/retroshare/webui/
--------
README reworked
2020-02-12 19:46:51 -05:00
The web UI is only accessible on localhost:9090. It is advised to keep it that way so that your RS
Drop libresapi and modules that depends on it A copy of the repository freezed before this deletion to ease old code viewing is available at https://github.com/RetroShare/zz_archive_RetroShare_libresapi Removed some more cruft Temporarly disabled JSON API generation of RsWebUi methods due to compilation breakage when rs_webui is disabled, RsWebUi keeps working but cannot be restarted from JSON API
2019-11-27 17:32:38 -05:00
cannot be controlled using an untrusted connection.
README reworked
2020-02-12 19:46:51 -05:00
To access your web UI from a distance, just open a SSH tunnel to it:
Drop libresapi and modules that depends on it A copy of the repository freezed before this deletion to ease old code viewing is available at https://github.com/RetroShare/zz_archive_RetroShare_libresapi Removed some more cruft Temporarly disabled JSON API generation of RsWebUi methods due to compilation breakage when rs_webui is disabled, RsWebUi keeps working but cannot be restarted from JSON API
2019-11-27 17:32:38 -05:00
[source,bash]
--------
distant_machine:~/ > ssh rs_host -L 9090:localhost:9090 -N
--------
README reworked
2020-02-12 19:46:51 -05:00
"rs_host" is the machine running `retroshare-nogui`. Then on the distant machine, access your web UI on
Drop libresapi and modules that depends on it A copy of the repository freezed before this deletion to ease old code viewing is available at https://github.com/RetroShare/zz_archive_RetroShare_libresapi Removed some more cruft Temporarly disabled JSON API generation of RsWebUi methods due to compilation breakage when rs_webui is disabled, RsWebUi keeps working but cannot be restarted from JSON API
2019-11-27 17:32:38 -05:00
http://localhost:9090
README reworked
2020-02-12 19:46:51 -05:00
(This can also be done from the RetroShare GUI.)
Reference in New Issue Copy Permalink