From 6cfb69f8a265ffadead2275c13c74178b17b5184 Mon Sep 17 00:00:00 2001
From: xengineering <me@xengineering.eu>
Date: Fri, 27 Sep 2024 15:59:53 +0200
Subject: doc: Remove lldpd server

The goal is to switch to IPv6 link-local addresses only. They have the
advantage that they can be static by a hardware MAC address, are suited
for local network streaming and discovery can be done by using the
`ping` utility. Additionally the address can be calculated based on MAC
addresses which can be printed on the case and typed into the client by
the user. Thus this makes network discovery only a convenience feature
instead of a required one.

Removing the LLDP-based discovery is the first step into this direction.
---
 doc/documentation.tex | 49 ++++++++++---------------------------------------
 1 file changed, 10 insertions(+), 39 deletions(-)

(limited to 'doc/documentation.tex')

diff --git a/doc/documentation.tex b/doc/documentation.tex
index 14cab4f..4e50eb0 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -41,7 +41,6 @@ The following features are supported by the given \texttt{soundbox} version.
 	\item audio streaming with original sound quality
 	\item multi room audio without audible delay
 	\item 3D printed case to protect internals
-	\item discovery service to find the IP address of the device
 	\item safe shutdown by power cut
 \end{itemize}
 
@@ -52,9 +51,6 @@ below.
 	\item only the command line tool \texttt{ffmpeg} is currently supported to
 	      stream content to \texttt{soundbox} devices
 	\item no user friendly way to set the WLAN name (SSID) and password
-	\item network discovery requires the \texttt{lldpd} service for Unix
-	      operating systems or other client services for the
-	      Link~Layer~Discovery~Protocol
 	\item no user friendly update mechanism
 \end{itemize}
 
@@ -86,23 +82,6 @@ In addition to \autoref{chap:introduction} `\nameref{chap:introduction}` the
 following sections document everything required to use \texttt{soundbox}
 devices.
 
-\section{Discover soundbox IP address}
-
-If the IP address of the soundbox device is not known it can be discovered via
-the Link Layer Discovery Protocol (LLDP). This can be done with a software like
-lldpd\footnote{\href{https://lldpd.github.io/}{https://lldpd.github.io/}}. If
-the corresponding service is running the currently discovered devices can be
-looked up with \texttt{lldpcli}. Root privileges are required to use this
-command.
-
-\begin{verbatim}
-lldpcli show neighbors
-\end{verbatim}
-
-A device with the system name \texttt{soundbox.local} should show up. Every 30
-seconds a new discovery packet is emitted by soundbox. Thus it can take up to
-30 seconds until it shows up.
-
 \section{Playing audio} \label{playing-audio}
 
 Audio can be streamed to \texttt{soundbox} devices with the \texttt{ffmpeg}
@@ -272,8 +251,6 @@ busybox-mdev-openrc
 chrony
 ffplay
 iw
-lldpd
-lldpd-openrc
 openssh
 openssl
 wpa_supplicant' > /etc/apk/world
@@ -281,22 +258,6 @@ wpa_supplicant' > /etc/apk/world
 apk add
 \end{verbatim}
 
-\subsection{LLDP network discovery}
-
-To make the soundbox device discoverable inside the network the Link Layer
-Discovery Protocol (LLDP) is used. With \texttt{echo} a new configuration file
-for the \texttt{lldpd} software can be added. After configuration the
-\texttt{lldpd} service is enabled via \texttt{rc-update} to start by default
-with the next reboot.
-
-\begin{verbatim}
-echo 'configure system hostname soundbox.local
-configure lldp agent-type nearest-customer-bridge' \
-> /etc/lldpd.d/soundbox.conf
-
-rc-update add lldpd default
-\end{verbatim}
-
 \subsection{Audio configuration}
 
 The only user on a soundbox device is \texttt{root}. Even that super user has
@@ -424,6 +385,16 @@ All notable changes to \texttt{soundbox} will be documented here.
 \texttt{soundbox} adheres to Semantic
 Versioning\footnote{\href{https://semver.org/spec/v2.0.0.html}{https://semver.org/spec/v2.0.0.html}}.
 
+\section{Unreleased - YYYY-MM-DD}
+
+\href{https://cgit.xengineering.eu/soundbox}{https://cgit.xengineering.eu/soundbox}
+
+\subsection{Removed}
+
+\begin{itemize}
+	\item network discovery based on the LLDP protocol
+\end{itemize}
+
 \section{0.1.0 - 2024-02-02}
 
 \href{https://cgit.xengineering.eu/soundbox/tag/?h=0.1.0}{https://cgit.xengineering.eu/soundbox/tag/?h=0.1.0}
-- 
cgit v1.2.3-70-g09d2

