potato-mesh

(β˜… 446)

A federated, Meshtastic AND Meshcore node dashboard for your local community. No MQTT clutter, just local LoRa aether.

  • .codecov.yml
  • .dockerignore
  • .env.example
  • .gitignore
  • ACCEPTANCE.md
  • CHANGELOG.md
  • CLAUDE.md
  • configure.sh
  • docker-compose.dev.yml
  • docker-compose.prod.yml
  • docker-compose.yml
  • DOCKER.md
  • Dockerfile
  • flake.lock
  • flake.nix
  • LICENSE
  • PROMETHEUS.md
  • README.md
  • scrot-0.1.png
  • scrot-0.2.png
  • scrot-0.3.png
  • scrot-0.4.png
  • scrot-0.5.png
  • scrot-0.6.png
  • scrot-0.7.png
  • SPEC.md

# Installation Guide

1. Get the code
git clone https://github.com/l5yth/potato-mesh

Downloads the entire project code from GitHub to your computer.

cd potato-mesh

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Ruby Ruby is required to use gem.
  • Python 3 Python is required to use pip.
gem install sinatra sqlite3 rackup puma rspec rack-test rufo prometheus-client

Installs the package published on RubyGems directly.

pip install -U meshtastic

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker pull ghcr.io/l5yth/potato-mesh-web-linux-amd64:latest

Type this command into your terminal and run it.

docker pull ghcr.io/l5yth/potato-mesh-web-linux-arm64:latest

Type this command into your terminal and run it.

docker pull ghcr.io/l5yth/potato-mesh-web-linux-armv7:latest

Type this command into your terminal and run it.

docker pull ghcr.io/l5yth/potato-mesh-ingestor-linux-amd64:latest

Type this command into your terminal and run it.

docker pull ghcr.io/l5yth/potato-mesh-ingestor-linux-arm64:latest

Type this command into your terminal and run it.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Gradle (Java/Kotlin)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java/Kotlin projects.
  • Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd app/android/app

This project's files live in a subfolder, so move into it first.

./gradlew build

Builds the project using Gradle.

βœ… A BUILD SUCCESSFUL message means it worked. The output is created under build/.

5. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
cd web

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

6. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
python -m venv .venv

Runs the Python script (or module).

pip install -U meshtastic

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

7. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cd matrix

This project's files live in a subfolder, so move into it first.

cargo build --release

Compiles the Rust project.

cargo run

Builds and then immediately runs the program.

βœ… If cargo build finishes without errors, it worked. The executable is created under target/.

8. Ruby

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Ruby Ruby is required to use the bundle command.
bundle install

Installs the Ruby libraries listed in the Gemfile.

βœ… If bundle install finishes without errors, continue with the run command from the README (e.g. rails server).

Pulled directly from this repo's README.

// repository documentation