RetroShare is a Free and Open Source cross-platform, Friend-2-Friend and secure decentralised communication platform.
Go to file
csoler b7e3300689
Merge pull request #1670 from csoler/v0.6-GXS-DistSync
fixed bug causing crash when forum being displayed is deleted
2019-10-06 00:18:58 +02:00
build_scripts Add support to build with miniupnpc on Android 2019-09-28 13:54:16 +02:00
data
jsonapi-generator More fixes in JSON API 2019-08-29 01:24:51 +02:00
libbitdht/src
libresapi/src switched to RsLoginHelper for login attempt in rs-service. Moved commandline arguments to main executable using a new struct named RsConfigOptions 2019-08-29 23:15:46 +02:00
libretroshare/src Improve error reporting in createChannelV2 2019-10-05 15:53:46 +02:00
openpgpsdk/src
plugins
rapidjson-1.1.0
retroshare-android-notify-service/src
retroshare-android-service/src
retroshare-gui/src Merge pull request #1670 from csoler/v0.6-GXS-DistSync 2019-10-06 00:18:58 +02:00
retroshare-nogui/src switched to RsLoginHelper for login attempt in rs-service. Moved commandline arguments to main executable using a new struct named RsConfigOptions 2019-08-29 23:15:46 +02:00
retroshare-qml-app/src
retroshare-service fixed compilation 2019-09-15 17:23:48 +02:00
supportlibs Update udp-discovery-cpp and android openssl 2019-08-29 15:52:07 +02:00
tests
.gitignore
.gitmodules
.travis.yml Fix CMark compilation 2019-08-28 04:53:47 +02:00
android-prepare-toolchain.sh
appveyor.yml Merge pull request #1624 from csoler/v0.6-RetroshareService 2019-09-09 10:33:18 +02:00
LICENSE.AGPL.txt
LICENSE.txt
MacOS_X_InstallGuide.md
README-Android.asciidoc
README.md
retroshare.pri Fix retroshare-service Android build 2019-09-10 17:10:26 +02:00
RetroShare.pro
TODO.circles.txt
TODO.txt
travis_makeOSXPackage.sh
WindowsMSys2_InstallGuide.md Updated the readme to fix Windows' build 2019-05-12 18:30:30 +02:00

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 dont 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