diff options
Diffstat (limited to 'INSTALL.md')
| -rw-r--r-- | INSTALL.md | 141 |
1 files changed, 77 insertions, 64 deletions
@@ -1,23 +1,54 @@ -Required dependencies: -====================== - -* A C++11 compiler -* Boost 1.48 or later -* ZeroMQ 4 or later -* (optional) cURL to download the TAI-UTC bulletin, needed for timestamps in EDI and ZMQ output. - -Dependencies on Debian (and Ubuntu) ------------------------------------ - -On Debian and Ubuntu you will need to install the following packages: - - sudo apt-get install build-essential libzmq5-dev automake libboost-system-dev libcurl4-openssl-dev - - -Dependencies on CentOS ----------------------- - -In addition to the packages needed to install a compiler, install the packages: +You have 3 ways to install odr-dabmux on your host: + +# Using binary debian packages +If your host is running a debian-based OS and its cpu is one of amd64, arm64 or arm/v7, then you can install odr-dabmux using the standard debian packaging system: +1. Update the debian apt repository list: + ``` + curl -fsSL http://debian.opendigitalradio.org/odr.asc | sudo tee /etc/apt/trusted.gpg.d/odr.asc 1>/dev/null + curl -fsSL http://debian.opendigitalradio.org/odr.list | sudo tee /etc/apt/sources.list.d/odr.list 1>/dev/null + ``` +1. Refresh the debian packages list: + ``` + apt update + ``` +1. Install odr-audioenc: + ``` + sudo apt install --yes odr-dabmux + ``` + +**Attention**: odr-dabmux (4.2.1-1) does not include the Mux Web Management GUI + +# Using the dab-scripts +You can compile odr-dabmux as well as the other main components of the mmbTools set with an installation script: +1. Clone the dab-scripts repository: + ``` + git clone https://github.com/opendigitalradio/dab-scripts.git + ``` +1. Follow the [instructions](https://github.com/Opendigitalradio/dab-scripts/tree/master/install) + +# 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: +``` +# Required packages +## C++11 compiler +sudo apt-get install --yes build-essential automake libtool + +## ZeroMQ +sudo apt-get install --yes libzmq3-dev libzmq5 + +## Boost 1.48 or later +sudo apt-get install --yes libboost-system-dev + +# optional packages +## cURL to download the TAI-UTC bulletin, needed for timestamps in EDI output +sudo apt-get install --yes libcurl4-openssl-dev +``` + +### Dependencies on other linux distributions +For CentOS, in addition to the packages needed to install a compiler, install the packages: boost-devel libcurl-devel zeromq-devel Third-party RPM packages are maintained by RaBe, and are built by the @@ -28,46 +59,37 @@ 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). -Compiling ODR-DabMux -==================== - +## 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. -* Download and install the dependencies as above -* Clone the git repository, master branch - - % git clone https://github.com/Opendigitalradio/ODR-DabMux.git - -* or next branch - - % git clone -b next https://github.com/Opendigitalradio/ODR-DabMux.git - -* Bootstrap autotools: - - % cd ODR-DabMux/ - % ./bootstrap.sh - -* Run the configure script - - % ./configure - -* Build ODR-DabMux - - % make - -* Install ODR-DabMux (as root) - - % sudo make install - -It is advised to run the bootstrap and configure steps again every -time you pull updates from the repository. - -Develop on OSX and FreeBSD -========================== - +1. Clone this repository: + ``` + # 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 + ``` + cd ODR-PadEnc + ./bootstrap + ./configure + ``` +1. Compile and install: + ``` + 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 @@ -83,12 +105,3 @@ before calling ./configure On both systems, RAW output is not available. Note that these systems are not tested regularly. - -Advanced installation procedure: -================================ - -The configure script can be launched with a variety of options, launch the -following command for a complete list: - - % ./configure --help - |