diff options
Diffstat (limited to 'INSTALL.md')
| -rw-r--r-- | INSTALL.md | 64 |
1 files changed, 38 insertions, 26 deletions
@@ -1,25 +1,26 @@ +# Installation + You have 3 ways to install odr-dabmux on your host: -# Using your linux distribution packaging system -`odr-dabmux` is available on the official repositories of several debian-based distributions, such as Debian -(from Debian 12), Ubuntu (from 24.10), Opensuse and Arch. +## Installing binary packages on some linux distributions -If you are using Debian 12 (Bookworm), you will need to -[add the backports repository](https://backports.debian.org/Instructions/) +[](https://repology.org/project/odr-dabmux/versions) -**Notice**: this debian package does not include the Mux Web Management GUI +## Using installation scripts -# Using installation scripts If your linux distribution is debian-based, you can install odr-dabmux -as well as the other main components of the mmbTools set with the +as well as the other main components of the mmbTools set with the [Opendigitalradio dab-scripts](https://github.com/opendigitalradio/dab-scripts.git) -# Compiling manually +## Compiling manually + Unlike the 2 previous options, this one allows you to compile odr-dabmux with the features you really need. -## Dependencies -### Debian Bullseye-based OS: -``` +### Dependencies + +#### Debian Bullseye-based OS + +```sh # Required packages ## C++11 compiler sudo apt-get install --yes build-essential automake libtool @@ -35,7 +36,8 @@ sudo apt-get install --yes libboost-system-dev sudo apt-get install --yes libcurl4-openssl-dev ``` -### Dependencies on other linux distributions +#### Other linux distributions + For CentOS, in addition to the packages needed to install a compiler, install the packages: boost-devel libcurl-devel zeromq-devel @@ -47,49 +49,59 @@ the [radio RaBe repository](https://github.com/radiorabe/). For openSUSE, mnhauke is maintaining packages, also built using [OBS](https://build.opensuse.org/project/show/home:mnhauke:ODR-mmbTools). -## Compilation +### Compilation + The *master* branch in the repository always points to the latest release. If you are looking for a new feature or bug-fix that did not yet make its way into a release, you can clone the *next* branch from the repository. 1. Clone this repository: - ``` + + ```sh # stable version: git clone https://github.com/Opendigitalradio/ODR-DabMux.git # or development version (at your own risk): git clone https://github.com/Opendigitalradio/ODR-DabMux.git -b next ``` + 1. Configure the project - ``` + + ```sh cd ODR-DabMux ./bootstrap ./configure ``` + 1. Compile and install: - ``` + + ```sh make sudo make install ``` Notes: + - It is advised to run the bootstrap and configure steps again every time you pull updates from the repository. - The configure script can be launched with a variety of options. Run `./configure --help` to display a complete list -# Develop on OSX and FreeBSD -If you want to develop on OSX platform install the necessary build tools -and dependencies with brew +## Develop on OSX and FreeBSD + +If you want to develop on OSX platform install the necessary build tools and dependencies with brew - brew install boost zeromq automake curl +```sh +brew install boost zeromq automake curl +``` On FreeBSD, pkg installs all dependencies to /usr/local, but the build tools will not search there by default. Set the following environment variables before calling ./configure - LDFLAGS="-L/usr/local/lib" - CFLAGS="-I/usr/local/include" - CXXFLAGS="-I/usr/local/include" +```sh +LDFLAGS="-L/usr/local/lib" +CFLAGS="-I/usr/local/include" +CXXFLAGS="-I/usr/local/include" +``` -On both systems, RAW output is not available. Note that these systems -are not tested regularly. +On both systems, RAW output is not available. Note that these systems are not tested regularly. |