Portainer Templates logo

Portainer Templates

Pi.alert Pi.alert

Container

Network

WIFI / LAN intruder detector

Image details

Pulls: 2.6M
Architecture: amd64, arm64, arm/v7, arm/v6
Image size: 72 MB
Latest: 25.2
User: jokobsk
Created: Dec 24, 2021
Updated: 1 years ago
Status: active

Configuration

Type
Container
Platform
linux
Image
jokobsk/pi.alert
Ports
20211:20211/udp
Volumes
/config : /portainer/Files/AppData/Config/pi.alert
Env vars
PUID=1000PGID=100
Restart
always

Template by xneo1

Standalone Install

Select an install method, to see config/commands for deploying Pi.alert

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Pi.alert, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

More install options in our documentation.

⚠ Please migrate to/use the NetAlertX image: https://docs.netalertx.com/MIGRATION

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs pi.alert
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:20211 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :20211
  • Stop the other service, or pick a different host port. In 20211:20211 only the left number is yours to change, the right one belongs to the app.

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:100 /portainer/Files/AppData/Config/pi.alert
  • Or set the PUID and PGID variables (defaults 1000:100) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull jokobsk/pi.alert

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64, arm/v7, arm/v6
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The always restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect pi.alert --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A single container

Pi.alert runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Pi.alert needs bundled into one download. This template pulls jokobsk/pi.alert, which Docker fetches once (about 72 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Pi.alert's comes from Docker Hub, published by jokobsk.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is 25.2. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, arm/v7, arm/v6, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 20211:20211 means it's reachable on port 20211 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 20211:20211 over UDP

Volumes

A volume is where Pi.alert keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /config from /portainer/Files/AppData/Config/pi.alert on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Pi.alert takes 2 of them, all with defaults you can leave alone or tweak:

  • PUID, defaults to 1000
  • PGID, defaults to 100

Restart policy

The restart policy here is always, so Docker brings Pi.alert back up after a crash and again when the server reboots. Good for anything you want running around the clock. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Users and permissions

The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.

Networking

Nothing custom is set, so Pi.alert sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container pi.alert. That's what you'll spot in the containers list and use in commands like docker logs pi.alert.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Pi.alert up. Add the template list to Portainer once, then deploying Pi.alert is a click rather than a wall of config.