Documentation

Installation

Get MudPi up and running on your Raspberry Pi in a few simple steps.

Prerequisites

  • Raspberry Pi (3B+, 4, or Zero W recommended)
  • MicroSD card (16GB+ recommended)
  • Raspberry Pi OS (Bullseye or later recommended)
  • Python 3.9 or later (Python 3.9 through 3.14 supported)
  • Internet connection (WiFi or Ethernet)
  • SSH access enabled

Tip

New to Raspberry Pi? Check out our Raspberry Pi Setup Guide first.

Quick Install

The fastest way to install MudPi is using the install script. SSH into your Raspberry Pi and run:

Shell 
curl -sL https://install.mudpi.app | bash

This will install all dependencies including Python 3, Redis, and the MudPi core system.

Manual Installation

If you prefer a manual install, follow these steps:

1. Install Dependencies

Shell 
sudo apt-get update
sudo apt-get install -y python3 python3-pip redis-server

Note

MudPi requires Python 3.9+. On older Raspberry Pi OS images you may need to install a newer Python version. Check with python3 --version.

2. Clone the Repository

Shell 
git clone https://github.com/olixr/MudPi.git
cd MudPi

3. Install Python Packages

Shell 
pip3 install -r requirements.txt

4. Configure MudPi

Copy the example configuration and customize it for your setup:

Shell 
cp mudpi.config.example.json mudpi.config.json
nano mudpi.config.json

5. Start MudPi

Shell 
python3 mudpi.py

Running as a Service

To run MudPi as a background service that starts on boot:

Shell 
sudo cp mudpi.service /etc/systemd/system/
sudo systemctl enable mudpi
sudo systemctl start mudpi

Note

You can check the service status anytime with sudo systemctl status mudpi and view logs with journalctl -u mudpi -f.

Next Steps

Once installed, head over to Configuration to learn how to set up your sensors, controls, and schedules.

Next Configuration →