Skip to content

README.md

Latest commit

 

History

History
243 lines (192 loc) · 6.52 KB

README.md

File metadata and controls

243 lines (192 loc) · 6.52 KB
Raw

SmokePing

Build Status Last Commit OCI Pulls

Network latency monitor with historical graphing — tracks round-trip times and packet loss to your hosts over time.
Port 80
Registry ghcr.io/daemonless/smokeping
Source https://github.com/oetiker/smokeping
Website https://oss.oetiker.ch/smokeping/

Version Tags

Tag Description Best For
pkg FreeBSD Port. Built from FreeBSD packages. Production stability.
latest / pkg-latest FreeBSD Latest. Rolling package updates. Staying current.

Prerequisites

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions.

Deployment

Podman Compose

services:
  smokeping:
    image: "ghcr.io/daemonless/smokeping:latest"
    container_name: smokeping
    environment:
      - PUID=1000  # User ID for the application process
      - PGID=1000  # Group ID for the application process
      - TZ=UTC  # Timezone for the container
    volumes:
      - "/path/to/containers/smokeping:/config"
      - "/path/to/containers/smokeping/data:/data"
    ports:
      - "80:80"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always

Save as compose.yaml, then run podman-compose up -d.

AppJail Director

.env:

# .env

DIRECTOR_PROJECT=smokeping
PUID=1000
PGID=1000
TZ=UTC

appjail-director.yml:

# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  smokeping:
    name: smokeping
    options:
      - container: 'args:--pull'
      - expose: '80:80 proto:tcp'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
    volumes:
      - smokeping: /config
      - smokeping_data: /data
volumes:
  smokeping:
    device: '/path/to/containers/smokeping'
  smokeping_data:
    device: '/path/to/containers/smokeping/data'

Makejail:

# Makejail

ARG tag=latest

OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/smokeping:${tag}

Save the files above, then run appjail-director up.

Warning

Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

To avoid exposing ports, just remove the expose option in your appjail-director.yml or from your command-line arguments.

Podman CLI

podman run -d --name smokeping \
  -p 80:80 \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -v /path/to/containers/smokeping:/config \
  -v /path/to/containers/smokeping/data:/data \
  ghcr.io/daemonless/smokeping:latest

Save as run.sh, then run sh run.sh.

AppJail

appjail oci run -Pd \
  -o overwrite=force \
  -o container="args:--pull" \
  -o virtualnet=":<random> default" \
  -o nat \
  -o expose="80:80 proto:tcp" \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -o fstab="/path/to/containers/smokeping /config <pseudofs>" \
  -o fstab="/path/to/containers/smokeping/data /data <pseudofs>" \
  ghcr.io/daemonless/smokeping:latest smokeping

Save the files above, then run sh run.sh.

Warning

Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

To avoid exposing ports, just remove the expose option in your appjail-director.yml or from your command-line arguments.

Bastille

Warning

Bastille's OCI support is experimental. It requires buildah and shares the host network stack (inherit). Mount volumes with --volume HOST JAIL; without it, image-declared volumes are stored under ${bastille_volumesdir}/${jail}.

services:
  smokeping:
    name: smokeping
    image: "ghcr.io/daemonless/smokeping:latest"
    network:
      - mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
    volumes:
      - "/path/to/containers/smokeping:/config"
      - "/path/to/containers/smokeping/data:/data"

Save as bastille-compose.yml, then run bastille up. Or via CLI:

bastille create -O \
  --env PUID=1000 \
  --env PGID=1000 \
  --env TZ=UTC \
  --volume /path/to/containers/smokeping /config \
  --volume /path/to/containers/smokeping/data /data \
  smokeping ghcr.io/daemonless/smokeping:latest inherit

Ansible

- name: Deploy smokeping
  containers.podman.podman_container:
    name: smokeping
    image: "ghcr.io/daemonless/smokeping:latest"
    state: started
    restart_policy: always
    env:
      PUID: "1000"
      PGID: "1000"
      TZ: "UTC"
    ports:
      - "80:80"
    volumes:
      - "/path/to/containers/smokeping:/config"
      - "/path/to/containers/smokeping/data:/data"

Save as smokeping-deploy.yaml, then run ansible-playbook smokeping-deploy.yaml.

Access at: http://localhost:80

Parameters

Environment Variables

Variable Default Description
PUID 1000 User ID for the application process
PGID 1000 Group ID for the application process
TZ UTC Timezone for the container

Volumes

Path Description
/config Configuration directory (Probes, Targets, etc.)
/data Data directory (RRD database files)

Ports

Port Protocol Description
80 TCP Web UI

Architectures: amd64, aarch64 User: bsd (UID/GID via PUID/PGID, defaults to 1000:1000) Base: FreeBSD 15

Need help? Join our Discord community.