mirror of https://github.com/RetroShare/RetroShare.git synced 2024-10-01 02:35:48 -04:00

RetroShare is a Free and Open Source cross-platform, Friend-2-Friend and secure decentralised communication platform.

Go to file

sehraf 3bb03ff89d Added new (optional) callback to libbitdht to ask upper layer if an IP is banned. In case this callback is implemented it will be used in favour of the built-in ban list.		2016-06-20 22:30:51 +02:00
build_scripts	Merge pull request #259 from heini/rhel_fedora_qt5	2016-06-05 13:02:13 -04:00
data	Add trailing semi-colon to MimeType in .desktop files	2016-04-16 20:44:14 +02:00
libbitdht/src	Added new (optional) callback to libbitdht to ask upper layer if an IP is banned.	2016-06-20 22:30:51 +02:00
libresapi/src	merged with upstream/master	2016-06-16 20:19:03 -04:00
libretroshare/src	Added new (optional) callback to libbitdht to ask upper layer if an IP is banned.	2016-06-20 22:30:51 +02:00
msys2_build_libs	Add Build Status in ReadMe.md file.	2016-06-15 20:53:56 +02:00
openpgpsdk/src	remove compiler warnings openpgpsdk	2016-06-01 21:20:50 +02:00
plugins	pass over compiler warnings	2016-06-05 10:43:57 -04:00
retroshare-gui/src	fixed permission matrix widget crash	2016-06-18 16:27:15 -04:00
retroshare-nogui/src	second pass over compilation warnings	2016-06-05 11:05:52 -04:00
rsctrl/src	updated ubuntu changelog	2015-09-21 22:58:58 -04:00
supportlibs/pegmarkdown	Fix error reported by CppChecker:	2016-03-20 13:12:30 +01:00
tests	added explicit comparisons for tests on RsGxsGrpMetaData and RsGxsMsgMetaData	2016-06-18 20:38:48 -04:00
win_build_libs	Make VOIP running with newer FFmpeg version.	2015-10-17 12:15:36 +02:00
.gitignore	Remove Thumbs.db files and add to .gitignore	2015-08-27 22:35:28 +02:00
.travis.yml	Updated Travis file.	2016-05-01 21:09:21 +02:00
appveyor.yml	Change Build AppVeyor State to RetroShare/RetroShare.	2016-06-19 01:40:50 +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.txt	Update MacOS_X_InstallGuide.txt	2015-12-26 17:20:54 +01:00
README.md	Change Build AppVeyor State to RetroShare/RetroShare.	2016-06-19 01:40:50 +02:00
retroshare.pri	Fix preprocessor for MacOS version.	2016-05-06 22:51:25 +02:00
RetroShare.pro	- make tests compile	2016-02-13 11:55:25 +01:00
Start_RetroShare-Gui_Debug.bat	Fix Windows 7 32b Compilation from scratch.	2015-10-17 12:15:35 +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.txt	Add MSys2 Install Guide	2015-10-17 12:15:36 +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)
Windows, `MSys2` (via appveyor)

Compilation on Windows

Follow this file : WindowsMSys2_InstallGuide.txt

Compilation on MacOSX

Follow this file : MacOS_X_InstallGuide.txt

Compilation on Linux

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 sqlcipher

Checkout the source code

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

Compile
```
cd trunk
qmake CONFIG+=debug
make
```

Install

sudo make install

The executables produced will be:

  /usr/bin/RetroShare06
  /usr/bin/RetroShare06-nogui

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/RetroShare06/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

README.md Unescape Escape