From 908da30369f2e25f9045a069a25b5c9d244762a0 Mon Sep 17 00:00:00 2001
From: "Matthias P. Braendli" <matthias.braendli@mpb.li>
Date: Tue, 19 Jul 2022 17:09:50 +0200
Subject: Describe three installation methods

---
 introduction.tex | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)

(limited to 'introduction.tex')

diff --git a/introduction.tex b/introduction.tex
index cecd4c7..e3e11c6 100644
--- a/introduction.tex
+++ b/introduction.tex
@@ -177,4 +177,61 @@ Additionally, it can output statistics in YAML format, which is useful in
 combination with an RTLSDR receiver and the \verb+dab2eti+ tool to monitor
 transmissions.
 
+\section{Installation of the Tools}
+There are 3 ways to install the tools.
+
+\subsection{Debian Binary Packages}
+If your host is running a debian-Bullseye-based operating system and its
+architecture is one of amd64, arm64 or arm/v7, then you can easily install
+ODR-AudioEnc, ODR-PadEnc, ODR-DabMux and ODR-DabMod
+from the ODR package repository by applying the following steps:
+
+\begin{lstlisting}
+    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
+    apt update
+    sudo apt install --yes odr-audioenc odr-padenc odr-dabmux odr-dabmod
+\end{lstlisting}
+
+\paragraph{Remarks}
+The \texttt{odr-dabmux} and \texttt{odr-dabmod} packages do not include the web-based GUI Mux Manager
+and the GUI and Digital Predistortion Computation engine. If you need those, then you
+should look at the other 2 installation options below.
+
+\subsection{Opendigitalradio-provided Installation Script}
+This option allows you to compile and install:
+\begin{itemize}
+    \item the above 4 main components of the tools
+
+    \item the web-based GUI Encoder Manager, GUI Mux Manager, GUI and Digital
+        Predistortion Computation engine
+    \item sample configuration files
+\end{itemize}
+
+Apply the following steps:
+\begin{lstlisting}
+    sudo apt update && sudo apt upgrade --yes
+    sudo timedatectl set-timezone your_timezone
+    cd ${HOME}
+    git clone https://github.com/opendigitalradio/dab-scripts.git
+    bash ${HOME}/dab-scripts/install/mmbtools-get install
+\end{lstlisting}
+
+\paragraph{Remarks}
+The installation script will compile the tools with all the possible features
+in order to give you the greatest configuration flexibility. It will also
+install and configure the \texttt{supervisord} package with the sample configuration files.
+
+\subsection{Manual Compilation}
+If you wish to compile and install some tools only and reduce disk usage by
+selecting the needed features, then you should follow the instructions given
+with each tool:
+
+\begin{itemize}
+    \item \texttt{odr-audioenc} https://github.com/opendigitalradio/odr-audioenc
+    \item \texttt{odr-padenc} https://github.com/opendigitalradio/odr-padenc
+    \item \texttt{odr-dabmux} https://github.com/opendigitalradio/odr-dabmux
+    \item \texttt{odr-dabmod} https://github.com/opendigitalradio/odr-dabmod
+\end{itemize}
+
 % vim: spl=en spell tw=80 et
-- 
cgit v1.2.3

