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
RetroShare is a Free and Open Source cross-platform, Friend-2-Friend and secure decentralised communication platform.
13,127 Commits 63 Branches 22 Tags 194 MiB
C++ 85.6%
C 7%
QMake 1.6%
HTML 1.4%
NSIS 1%
Other 3.2%
7dab487bde
Go to file
Gioacchino Mazzurco 7dab487bde
Implement a JSON API friendly notification system 
This should bit by bit substitute RsNotify which would be very difficult
  to support properly in JSON API.
The new system is much simpler to use also from the C++ side of the
  moon.
BroadcastDiscovery take advantage of the new system to notify about new
  non friend peer discovered, tested successfully also in JSON API.
2019-04-15 00:31:49 +02:00
build_scripts Fix licensing in broadcast discovery and JSON API 2019-04-14 12:34:01 +02:00
data Add missing categories to desktop file 2019-02-05 15:02:15 +01:00
jsonapi-generator JSON API avoid capturing shared_ptr in lambda 2019-04-15 00:07:21 +02:00
libbitdht/src attempt to fix compilation of MacOS 2019-01-23 20:21:44 +01:00
libresapi/src Merge pull request #1478 from G10h4ck/jsonapi 2019-03-23 09:11:05 -03:00
libretroshare/src Implement a JSON API friendly notification system 2019-04-15 00:31:49 +02:00
openpgpsdk/src moved qmake files in openpgpsdk to Apache-2.0 2018-11-11 14:24:49 +01:00
plugins remove accidental code from retroshare_plugin.pri 2019-03-10 12:48:36 +04:00
rapidjson-1.1.0 added rapidjson-1.1.0 code hard-coded in the source directory to allow everyone to compile without the need to tweak too much. When v1.1.0 is mainstream (espcially on ubuntu) we can revert back to an external dependency 2018-05-02 22:46:27 +02:00
retroshare-android-notify-service/src Make .pro files compiler agnostic on Android 2018-01-30 18:11:31 +01:00
retroshare-android-service/src Implement JSON API HTTP Basic authentication 2018-09-19 21:28:26 +02:00
retroshare-gui/src Merge pull request #1512 from G10h4ck/csoler-jsonapi-channel 2019-04-11 10:13:52 +02:00
retroshare-nogui/src fixed retroshare.project email in licenses 2018-11-11 20:42:48 +01:00
retroshare-qml-app/src Multiple improvements to build process 2018-04-18 07:56:43 +02:00
retroshare-service retroshare-service add permission for android network usage 2019-02-07 16:38:18 -03:00
supportlibs Initial work on Broadcast Domain Discovery 2019-04-12 02:53:39 +02:00
tests fixed retroshare.project email in licenses 2018-11-11 20:42:48 +01:00
.gitignore Update .gitignore 2018-12-23 18:59:34 +01:00
.gitmodules Initial work on Broadcast Domain Discovery 2019-04-12 02:53:39 +02:00
.travis.yml Fix Travis and Appveyor continuous integration 2019-04-12 19:56:57 +02:00
android-prepare-toolchain.sh Merge branch 'json_experiments' 2018-04-27 18:17:09 +02:00
appveyor.yml Fix Travis and Appveyor continuous integration 2019-04-12 19:56:57 +02:00
LICENSE.AGPL.txt add AGPL license text 2019-04-06 14:48:45 +02:00
LICENSE.txt Update and rename license.txt to LICENSE.txt 2015-12-15 09:11:12 -08:00
MacOS_X_InstallGuide.md Fix typo in Mac install guide 2018-02-04 10:37:45 +01:00
README-Android.asciidoc retroshare-service now build and runs fine on android (even older ones) 2018-10-05 22:29:49 +02:00
README.md Update Appveyod build badge 2018-08-25 23:31:16 +02:00
retroshare.pri Initial work on Broadcast Domain Discovery 2019-04-12 02:53:39 +02:00
RetroShare.pro Converted extra targets into an extra compiler: 2019-03-10 01:49:47 +01:00
TODO.circles.txt updated TODO 2016-03-20 22:23:32 -04:00
TODO.txt update todo 2016-02-24 21:51:34 +01:00
travis_makeOSXPackage.sh new branch for MacOS release 2019-01-23 20:21:18 +01:00
WindowsMSys2_InstallGuide.md fixed JSONAPI build for Windows 2018-09-20 22:24:05 +02:00

README.md

RetroShare

RetroShare is a decentralized, private and secure commmunication and sharing platform. RetroShare provides filesharing, chat, messages, forums and channels.

Build Status

Platform Build Status
GNU/Linux, MacOS, (via travis-ci) Build Status
Windows, MSys2 (via appveyor) Build status

Compilation on Windows

Follow this file : WindowsMSys2_InstallGuide.md

Compilation on MacOSX

Follow this file : MacOS_X_InstallGuide

Compilation for Android

Follow this file : README-Android

Compilation on Linux

  1. Install package dependencies:

    • Debian/Ubuntu
    sudo apt-get install libglib2.0-dev libupnp-dev qt4-dev-tools \
    libqt4-dev libssl-dev libxss-dev libgnome-keyring-dev libbz2-dev \
    libqt4-opengl-dev libqtmultimediakit1 qtmobility-dev libsqlcipher-dev \
    libspeex-dev libspeexdsp-dev libxslt1-dev libcurl4-openssl-dev \
    libopencv-dev tcl8.5 libmicrohttpd-dev rapidjson-dev
    • openSUSE
    sudo zypper install gcc-c++ libqt4-devel libgnome-keyring-devel \
    glib2-devel speex-devel libssh-devel protobuf-devel libcurl-devel \
    libxml2-devel libxslt-devel sqlcipher-devel libmicrohttpd-devel \
    opencv-devel speexdsp-devel libupnp-devel libavcodec-devel rapidjson
    • Arch Linux
    pacman -S base-devel libgnome-keyring libmicrohttpd libupnp libxslt \
    libxss opencv qt4 speex speexdsp sqlcipher rapidjson

  2. Checkout the source code

    mkdir ~/retroshare
cd ~/retroshare 
git clone https://github.com/RetroShare/RetroShare.git trunk

  3. Compile

    cd trunk
qmake CONFIG+=debug
make

  4. Install

    sudo make install

    The executables produced will be:

      /usr/bin/retroshare
  /usr/bin/retroshare-nogui

  5. Uninstall:

    sudo make uninstall

Compile only retroshare-nogui

If you want to run RetroShare on a server and don’t need the gui and plugins, you can run the following commands to only compile/install the nogui version:

qmake
make retroshare-nogui
sudo make retroshare-nogui-install_subtargets

For packagers

Packagers can use PREFIX and LIB_DIR to customize the installation paths:

qmake PREFIX=/usr LIB_DIR=/usr/lib64 "CONFIG-=debug" "CONFIG+=release"
make
make INSTALL_ROOT=${PKGDIR} install

If libsqlcipher is not available as a package

You need to place sqlcipher so that the hierarchy is:

  retroshare
      |
      +--- trunk
      |
      +--- lib
            |
            +---- sqlcipher

mkdir lib
cd lib
git clone git://github.com/sqlcipher/sqlcipher.git
cd sqlcipher
./configure --enable-tempstore=yes CFLAGS="-DSQLITE_HAS_CODEC" LDFLAGS="-lcrypto"
make
cd ..

Using retroshare-nogui & webUI

The webUI needs to be enabled as a parameter option in retroshare-nogui:

./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 cannot be controlled using an untrusted connection.

To access your web UI from a distance, just open a SSH tunnel on it:

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

  http://localhost:9090

That also works with a retroshare GUI of course.

Compile and run tests

  qmake CONFIG+=tests
  make
  tests/unittests/unittests