Skip to content

Installation

icemanxbe edited this page Jun 17, 2026 · 1 revision

Installation & Running

MeadOS is deliberately simple to run: one Python file, no packages to install, no build step, no database server.

Requirements

  • Python 3.8 or newer (python3 --version to check)
  • Any operating system that runs Python — Windows, macOS, Linux, a Raspberry Pi, or a NAS/home server
  • A modern browser on each device you want to use

There is nothing else to install — MeadOS uses only the Python standard library, and the frontend is plain HTML/CSS/JavaScript with no build step.

Get the files

git clone https://github.com/icemanxbe/MeadOS.git
cd MeadOS

(Or download the repository as a ZIP and extract it.)

Run it

python3 server.py

Then open http://localhost:8080 in your browser. That's the whole setup.

Anyone else on your network can open http://<your-machine-ip>:8080 and they'll see the same shared data — there are no accounts and no per-device configuration. To find your machine's address, use ipconfig (Windows) or ifconfig/ip addr (macOS/Linux).

Command-line options

python3 server.py --port 9000             # listen on a different port
python3 server.py --db /path/to/meados.db # store data somewhere specific
python3 server.py --host 127.0.0.1        # local-only; do not expose on the LAN
python3 server.py --trust 100.64.0.0/10   # treat an extra network as "LAN" (repeatable)
Option Default Purpose
--host 0.0.0.0 Bind address. 127.0.0.1 keeps it on the local machine only.
--port 8080 TCP port.
--db meados.db SQLite database location. Created on first save.
--trust A CIDR range that should count as your LAN (for NAT hairpin / VPN / CDN). Repeatable.

Install it as an installable app (PWA)

MeadOS is a Progressive Web App. In a supporting browser (Chrome, Edge, Safari on iOS), use Install / Add to Home Screen to get an app icon and a standalone window. It uses your uploaded brand logo as the icon when you set one, supports iOS safe areas, and caches the app shell so the interface still opens offline.

Keep it running (always-on)

For a server that should always be available, run MeadOS under your operating system's service manager so it starts at boot and restarts if it ever stops. Step-by-step systemd (Linux) and launchd (macOS) examples — plus a quick nohup option — are on the Security & Deployment page.

Updating

cd MeadOS
git pull

Then restart the server (or your service). Your data lives in meados.db, which git pull never touches, so updates never disturb your batches. See Backups & Data before any big change.

Next step

Head to Getting Started to create your first batch.

Clone this wiki locally