mirror of https://github.com/RetroShare/RetroShare.git synced 2024-12-25 15:39:27 -05:00

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

Go to file

AsamK 4e917ea26c Disable compiling of pegmarkdown by default, only used for wiki - Move unfinished CONFIGs to common retroshare.pri file - Compile and link pegmarkdown only if CONFIG+=wikipoos is set		2015-09-05 09:25:08 +02:00
build_scripts	merged Pull Request #81 , providing avcodec video encoding/decoding	2015-09-02 22:39:39 -04:00
data	Move data dir from build_scripts/ to root and adapt RedHat build files	2015-08-25 00:56:50 +02:00
libbitdht/src	Move all INSTALLS to the subproject they belong to	2015-08-31 22:49:46 +02:00
libresapi/src	Revert "Fix Windows compilation of libresapi with error:"	2015-09-01 21:03:23 -04:00
libretroshare/src	Fixed Windows compile.	2015-09-03 13:14:39 +02:00
openpgpsdk/src	CONFIG shouldn't be reset at qmake call, use CONFIG+=… instead	2015-09-01 14:53:17 +02:00
plugins	Old libav versions used constant without AV_ prefix	2015-09-04 23:59:13 +02:00
retroshare-gui/src	Disable compiling of pegmarkdown by default, only used for wiki	2015-09-05 09:25:08 +02:00
retroshare-nogui/src	Fixed Windows compile.	2015-09-03 13:14:39 +02:00
rsctrl/src	Added Transfer State to RPC messages	2013-04-22 22:40:30 +00:00
supportlibs/pegmarkdown	Merged revision 7410 from v0.5.5	2014-06-21 21:12:27 +00:00
tests	updated tests and also fixed a few bugs in using random initialisation routines	2015-01-11 22:19:32 +00:00
.gitignore	Remove Thumbs.db files and add to .gitignore	2015-08-27 22:35:28 +02:00
.travis.yml	Fix Travis CI compilation by adding libavutil-dev package.	2015-09-04 17:28:45 +02:00
build-all-mingw32make.bat	update windows build scripts	2015-08-11 16:44:59 +02:00
README.md	Update README.md	2015-09-01 14:53:18 +02:00
retroshare.pri	Disable compiling of pegmarkdown by default, only used for wiki	2015-09-05 09:25:08 +02:00
RetroShare.pro	Disable compiling of pegmarkdown by default, only used for wiki	2015-09-05 09:25:08 +02:00
TODO.txt	Fixed layout of the ServicePermissionsPage	2015-08-08 22:46:31 +02:00

README.md

RetroShare

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

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

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 (unless you canged that option in the GUI). 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.

README.md Unescape Escape