Git-Mirrors/RetroShare
1
0
Fork 0
mirror of https://github.com/RetroShare/RetroShare.git synced 2024-12-25 15:39:27 -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.
12,484 Commits 63 Branches 22 Tags 196 MiB
C++ 85.6%
C 7%
QMake 1.6%
HTML 1.4%
NSIS 1%
Other 3.2%
92f90178c4
Go to file
Gioacchino Mazzurco 92f90178c4
RS version is now parametrizable at compile time 
Avoid the need of dirty patching to set the version at build time
In case RS version is not passed as argument attempt to determine it
  using git describe, if unavailable use hardcoded default
2018-09-12 10:49:36 +02:00
build_scripts updated ubuntu changelog 2018-09-04 20:53:52 +02:00
data Rename retroshare06 to retroshare 2017-07-17 10:45:18 +02:00
jsonapi-generator Prevent crash calling uninitialized service via JSON API 2018-09-01 15:29:09 +02:00
libbitdht/src merged upstream/master 2018-07-08 21:17:48 +02:00
libresapi/src added last relay (a.k.a which direct friend) of search results in sources column 2018-08-28 23:57:16 +02:00
libretroshare/src RS version is now parametrizable at compile time 2018-09-12 10:49:36 +02:00
msys2_build_libs Fixed MSYS2AUTOMAKE path in msys2_build_libs/Makefile 2016-08-12 14:14:09 +02:00
openpgpsdk/src license fix in pqi 2018-05-28 22:03:39 +02:00
plugins RS version is now parametrizable at compile time 2018-09-12 10:49:36 +02: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 retroshare-android-service better debug message 2018-09-06 02:05:29 +02:00
retroshare-gui/src RS version is now parametrizable at compile time 2018-09-12 10:49:36 +02:00
retroshare-nogui/src Merge branch 'master' into jsonapi 2018-09-05 00:17:21 +02:00
retroshare-qml-app/src Multiple improvements to build process 2018-04-18 07:56:43 +02:00
supportlibs Merge branch 'master' into jsonapi 2018-07-23 13:44:01 +02:00
tests RsTokenService use enum for request status 2018-06-24 18:56:48 +02:00
.gitignore Simplify QML to work better on both Desktop and Phone 2016-10-26 20:37:28 +02:00
.gitmodules Merge branch 'master' into jsonapi 2018-07-23 13:44:01 +02:00
.travis.yml Temporarily disable qmake step on Travis CI OS X 2018-09-05 12:57:13 +02:00
android-prepare-toolchain.sh Merge branch 'json_experiments' 2018-04-27 18:17:09 +02:00
appveyor.yml Fix AppVeyor Compilation 2018-08-02 00:39:45 +02:00
build-all-mingw32make.bat Fix Windows 7 32b Compilation from scratch. 2015-10-17 12:15:35 +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 Update Android quirks documentation 2018-03-12 17:06:01 +01:00
README.md Update Appveyod build badge 2018-08-25 23:31:16 +02:00
retroshare.pri RS version is now parametrizable at compile time 2018-09-12 10:49:36 +02:00
RetroShare.pro Merge branch 'master' into jsonapi 2018-08-22 16:59:42 +02:00
Start_RetroShare-Gui_Debug.bat Rename retroshare06 to retroshare 2017-07-17 10:45:18 +02: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
WindowsMSys2_InstallGuide.md changed to use CONFIG+=rs_autologin for the windows build instructions instead of setting defines 2018-08-03 21:29:00 +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