docker-meshview

Docker container for Meshview - a real-time monitoring and diagnostic tool for Meshtastic mesh networks.

Quick Start

Ensure you have Docker installed using the officially supported method.

https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository

# Clone the repo and enter its directory
$ git clone https://github.com/Sidpatchy/docker-meshview
$ cd docker-meshview

# Build the container
$ docker compose build --no-cache

# Initialize the config and database file
$ touch packets.db
$ chmod 666 packets.db

# Check your UID and GID
$ id
uid=1000(testuser) gid=1000(testuser) # You should get something like this

# Edit the docker-compose file to use your UID and GID
$ nano docker-compose.yml

# Change the PUID to your UID and the PGID to your GID
- PUID=1000
- PGID=1000

# Download the config from upstream and modify to your liking
$ curl -o config.ini https://raw.githubusercontent.com/pablorevilla-meshtastic/meshview/refs/heads/master/sample.config.ini
$ nano config.ini

# Start the contaner
$ docker compose up -d

Updating

# Bring down the stack
docker compose down

# Rebuild the containers
docker compose build --no-cache

# Bring the stack back up
docker compose up -d

Parameters

Ports

Ports are separated by a colon and indicate <EXTERNAL>:<INTERNAL>. For example, 9872:8081 would expose port 8081 from inside the container to be accessible from outside the container through port 9872.

Meshview container

Port	Function
8081:8081	HTTP(s) web UI

Database Cleanup Sidecar

N/A

Environment Variables

Meshview Container

Parameter	Function
CONFIG_FILE	Path to the config.ini file within the container (Optional)
DATABASE_FILE	Path to the packets.db file within the container. (Optional)
PUID	Process User ID - Avoids causing issues with permissions between the host and the container.
PGID	Process Group ID - Avoids causing issues with permissions between the host and the container.

Database Cleanup Sidecar

Parameter	Function
DATABASE_FILE	Path to the packets.db file within the container. (Optional)
RETENTION_DAYS	How many days to retain data (Optional) (Default: 14 days)