******
TuxBox
******

This is my version of a local network content sharing box, inspired by
the more famous PirateBox_; it is based on a plain Debian installation,
on which services are installed and configured.

.. _PirateBox: https://en.wikipedia.org/wiki/PirateBox

.. only:: html

   .. contents::

Requirements
============

You need a Single Board Computer or another device with a Debian_
installation; ideally a basic netinstall from the official installer,
with at most the SSH server and standard system utilities tasks, plus
any firmware required by your hardware.

* `Debian concatenateable images for armhf
  <https://deb.debian.org/debian/dists/trixie/main/installer-armhf/current/images/netboot/SD-card-images/>`_
* `Debian concatenateable images for arm64
  <https://deb.debian.org/debian/dists/trixie/main/installer-arm64/current/images/netboot/SD-card-images/>`_

.. _Debian: https://www.debian.org/distrib/

If not already on the board, you also need a wifi card capable of being
configured as an Access Point.

For storage, these instructions assume that the OS will be on an SD card
(or other small device, such as an eMMC) and that data will be on an
external hard disk mounted on ``/mnt/tuxbox``; if using the same hard
disk for everything you may want to keep the data under ``/srv/tuxbox``
or another suitable location.

Configuration
=============

Network
=======

Configure your network interfaces 

Access Point
------------

Install ``hostapd``, ``dnsmasq`` and some useful programs::

   apt install hostapd dnsmasq iw

Copy the ``hostapd`` example configuration::

   cp /usr/share/doc/hostapd/examples/hostapd.conf /etc/hostapd/hostapd.conf

and edit it as needed, changing at least the following values:

* ``interface=``
* ``ssid=``
* ``country_code=``

then unmask the systemd service::

   systemctl unmask hostapd

See also
========