Skip to content

Configuration

The setup.sh script is the easiest way to configure Catsplash. It offers an interactive menu with the following options:

  1. Configure and Install (Wizard): Step-by-step guide for installing dependencies, selecting interfaces, configuring WiFi, and creating systemd services.
  2. Start/Stop/Restart Services: Control hostapd, dnsmasq and Catsplash.
  3. View Status: Shows active services and database sessions.
  4. View Logs: Latest Catsplash log lines.
  5. Uninstall: Restores original configurations and removes files.
Ventana de terminal
sudo ./setup.sh

It also accepts direct commands:

Ventana de terminal
sudo ./setup.sh start
sudo ./setup.sh stop
sudo ./setup.sh status
sudo ./setup.sh logs
sudo ./setup.sh uninstall

The configuration file (/opt/catsplash/config.toml) is auto-generated by the wizard.

Catsplash requires two interfaces:

  • AP (Access Point): WiFi interface that broadcasts the hotspot.
  • WAN: Interface with Internet access (eth0, enp1s0, etc.).

The wizard creates four systemd services:

  • catsplash-ip.service: Assigns the static IP to the hotspot.
  • hostapd.service: WiFi access point.
  • dnsmasq.service: DHCP and DNS for clients.
  • catsplash.service: The captive portal itself.
Ventana de terminal
sudo systemctl status catsplash
sudo journalctl -u catsplash -f

For manual hostapd and dnsmasq configuration, see: