Welcome to Ring’s documentation!¶

Dependencies¶

The Ring installer uses python3. Please make sure it is installed before running it.

Initialize the repositories¶

./make-ring.py --init

On Linux¶

1. Build and install all the dependencies:

./make-ring.py --dependencies

Your distribution’s package manager will be used.

2. Build and install locally under this repository:

./make-ring.py --install

3. Run daemon and client that were installed locally:

./make-ring.py --run

You can then stop the processes with CTRL-C.

You can also run them in the background with the --background argument and then use the --stop command to stop them. Stdout and stderr go to daemon.log and client-gnome.log.

./make-ring.py --install --global-install

gnome-ring

./make-ring.py --uninstall

On OSX¶

You need to setup Homebrew (<http://brew.sh/>) since their is no built-in package manager on OSX.

Build and install all the dependencies:

./make-ring.py --dependencies

Build and install locally under this repository:

./make-ring.py --install

On Android¶

Please make sure you have the Android SDK and NDK installed, and that their paths are properly set. For further information, please visit <https://github.com/savoirfairelinux/ring-client-android>

Build and install locally under this repository:

./make-ring.py --install --distribution=Android

Linux¶

cd contrib
mkdir native
cd native
../bootstrap
make

cd ../../
./autogen.sh
./configure
make

make install

OSX¶

cd extras/tools
./bootstrap
make
export PATH=$PATH:/location/of/ring/daemon/extras/tools/build/bin

cd contrib
mkdir native
cd native
../bootstrap
make -j

cd ../../
./autogen.sh
./configure  --without-dbus --prefix=<install_path>
make

Basic Installation¶

These are generic installation instructions.

To install the appplication, type the following commands in a console, while in the root directory of this application:

mkdir -p build
cd build
cmake ..
make -j3
make install

The following options are often usefull to append to the cmake line:

-DRING_BUILD_DIR=<daemon install location>
-DCMAKE_INSTALL_PREFIX=<install location>
-DRING_XML_INTERFACES_DIR=<daemon dbus interface definitions directory>
-DCMAKE_BUILD_TYPE=<Debug to compile with debug symbols>
-DENABLE_VIDEO=<False to disable video support>

Explanation¶

This script will configure and prepare the compilation and installation of the program and correctly link it against Ring daemon.

All needed files will be built in “build” directory. So you have to go to this directory:

cd build

Then execute the Makefile, to compile the application (src, doc...)

make

Then install it all using:

make install

You have to use “sudo” to be able to install the program in a protected directory (which is the case by default and most of the time). Therefore it will ask for your system password.

OS X Install¶

Install necessary tools:

brew install cmake
brew install qt5
export CMAKE_PREFIX_PATH=<path_to_qt5>

hint: default install location with HomeBrew is /usr/local/Cellar/qt5

First make sure you have built ring daemon for OS X.

mkdir build && cd build
cmake .. -DCMAKE_INSTALL_PREFIX=<install_dir_of_daemon> [-DCMAKE_BUILD_TYPE=Debug for compiling with debug symbols]
make install

You can now link and build the OSX client with Ring daemon and LRC library

Internationalization¶

To regenerate strings for translations we use lupdate (within root of the project)

lupdate ./src/ -source-language en -ts translations/lrc_en.ts

Hint: On OSX lupdate is installed with Qt in /usr/local/Cellar/qt5/5.5.0/bin/ when installed with HomeBrew

Requirements¶

• Ring daemon
• libRingClient
• GTK+3 (3.10 or higher)
• Qt5 Core
• X11
• gnome-icon-theme-symbolic (certain icons are used which other themes might be missing)
• libebook1.2 / evolution-data-server (3.10 or higher)
• libnotify (optional, if you wish to receive desktop notifications of incoming calls, etc)
• gettext (optional to compile translations)

On Debian/Ubuntu these can be installed with:

sudo apt-get install g++ cmake libgtk-3-dev qtbase5-dev libclutter-gtk-1.0-dev gnome-icon-theme-symbolic libebook1.2-dev libnotify-dev gettext

On Fedora:

sudo yum install gcc-c++ cmake gtk3-devel qt5-qtbase-devel clutter-gtk-devel gnome-icon-theme-symbolic evolution-data-server-devel libnotify-devel gettext

Compiling¶

Run the following from the project root directory:

mkdir build
cd build
cmake ..
make

The following options are often usefull to append to the cmake line:

-DCMAKE_INSTALL_PREFIX=<install location>
-DLibRingClient_DIR=<path the the installed cmake module of LibRingClient>
-DLibRingClient_PROJECT_DIR=<path to the project folder of LibRingClient>

You can then simply run ./gnome-ring from the build directory

Installing¶

If you’re building the client for use (rather than testing of packaging), it is recommended that you install it on your system, eg: in ‘/usr’, ‘/usr/local’, or ‘/opt’, depending on your distro’s preference to get full functionality such as desktop integration. In this case you should perform a ‘make install’ after building the client.

Building without installing Ring daemon and libRingClient¶

It is possible to build ring-client-gnome without installing the daemon and libRingClient on your system (eg: in /usr or /usr/local):

1. build the daemon
2. when building libRingClient, specify the location of the daemon lib in the cmake options with -DRING_BUILD_DIR=, eg: -DRING_BUILD_DIR=/home/user/ring/daemon/src
3. to get the proper headers, we still need to make install libRingClient, but we don’t have to install it in /usr, so just specify another location for the install prefix in the cmake options, eg: -DCMAKE_INSTALL_PREFIX=/home/user/ringinstall
4. compile libRingClient and do ‘make install’, everything will be installed in the dir specified by the prefix

4. point the client to the libRingClient cmake module during configuration: -DLibRingClient_DIR=/home/user/ringinstall/lib/cmake/LibRingClient

Debugging¶

For now, the build type of the client is “Debug” by default, however it is useful to also have the debug symbols of libRingClient. To do this, specify this when compiling libRingClient with -DCMAKE_BUILD_TYPE=Debug in the cmake options.