Git-Mirrors/RetroShare
1
0
Fork 0
mirror of https://github.com/RetroShare/RetroShare.git synced 2024-12-25 23:49:35 -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.
11,783 Commits 63 Branches 22 Tags 196 MiB
C++ 85.6%
C 7%
QMake 1.6%
HTML 1.4%
NSIS 1%
Other 3.2%
1c698bff83
Go to file
Gioacchino Mazzurco 1c698bff83 Qml App add option to control DHT behaviour 
As bitDHT is very noisy and keeps the radio always on on mobile thus
having huge impact on the battery life, DHT is now turned on only when
the App is interacting with the user byt default, on the option tab it
is possible to change this behaviour to set it always off, always on or
active depending on user interaction.
To handle settings AppSettings singleton has been added and a button on
the sidebar to edit configurations too
2018-02-01 14:31:07 +01:00
build_scripts updated changelog 2017-12-24 10:36:08 +01:00
data Rename retroshare06 to retroshare 2017-07-17 10:45:18 +02:00
libbitdht/src Install bdboot.txt in Android 2018-01-29 16:14:14 +01:00
libresapi/src Cleanup a bit libresapi.pro 2018-01-30 18:04:24 +01:00
libretroshare/src Add support for SQLCipher on Android 2018-01-30 18:24:03 +01:00
msys2_build_libs Fixed MSYS2AUTOMAKE path in msys2_build_libs/Makefile 2016-08-12 14:14:09 +02:00
openpgpsdk/src More cleanup of .pro files 2018-01-30 18:25:04 +01:00
plugins Fix TravisCI on MacOS compilation. 2017-12-12 19:39:04 +01: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 Make .pro files compiler agnostic on Android 2018-01-30 18:11:31 +01:00
retroshare-gui/src slight optimization to showEvent() and save/restore visible items in file lists 2018-01-28 21:54:56 +01:00
retroshare-nogui/src Fix CppCheck in notifytxt.cc 2017-11-06 22:20:44 +01:00
retroshare-qml-app/src Qml App add option to control DHT behaviour 2018-02-01 14:31:07 +01:00
supportlibs/pegmarkdown fix C++ comment to avoid compilation error 2017-08-06 14:27:26 +07:00
tests fixed gxs unit tests 2018-01-07 23:02:22 +01:00
.gitignore Simplify QML to work better on both Desktop and Phone 2016-10-26 20:37:28 +02:00
.travis.yml Fix TravisCI on MacOS compilation. 2017-12-12 19:39:04 +01:00
android-prepare-toolchain.sh Add support for SQLCipher on Android 2018-01-30 18:24:03 +01:00
appveyor.yml Fix AppVeyor build by disabling SQLCipher 2017-08-13 14:34:43 +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 Rename retroshare06 to retroshare 2017-07-17 10:45:18 +02:00
README-Android.asciidoc Add support for SQLCipher on Android 2018-01-30 18:24:03 +01:00
README.md Rename retroshare06 to retroshare 2017-07-17 10:45:18 +02:00
retroshare.pri Add support for SQLCipher on Android 2018-01-30 18:24:03 +01:00
RetroShare.pro restored plugins removed by previous commit 2017-11-21 09:27:21 +01: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 Fix Travis MacOS compilation since speex 1.2 split. 2017-01-04 21:13:45 +01: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
    • 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
    • Arch Linux
    pacman -S base-devel libgnome-keyring libmicrohttpd libupnp libxslt \
    libxss opencv qt4 speex speexdsp sqlcipher

  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