Portainer Templates logo

Portainer Templates

Klaxon Klaxon

Stack

DocumentsNetwork OtherTools

Klaxon is a free, quick to set up and easy to use robot that checks websites regularly so you don't have to.

Configuration

Type
Compose
Env vars
SMTP_PROVIDER=SENDGRIDSENDGRID_USERNAME=SENDGRID_PASSWORD=ADMIN_EMAILS=
Source
Repo

Template by mediadepot·Source

Services

database

Configuration

Image
postgres:11
Volumes
/var/lib/postgresql/data : /opt/mediadepot/apps/klaxon/db

Image details

Pulls: 11.2B
User: stackbrew
Created: Jun 05, 2014
Updated: 1 hour ago
Status: active

app

Configuration

Image
mediadepot/klaxon
Volumes
/config : /opt/mediadepot/apps/klaxon/app
Env vars
RACK_ENV=developmentRAILS_ENV=developmentDATABASE_URL=postgres://postgres@database/klaxonSECRET_KEY_BASE=secret_key_base

Image details

Pulls: 227k
User: mediadepot
Created: Dec 23, 2018
Updated: 5 years ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Klaxon

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 Klaxon, fill in any config options, and hit Deploy

Template Import URL

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

The compose file this template deploys, straight from its repo:

version: "2.1"

services:

  database:
    image: "postgres:11"
    volumes:
      - /opt/mediadepot/apps/klaxon/db:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U postgres"]
      interval: 10s
      timeout: 5s
      retries: 5
    networks:
      - traefik
      - klaxon
  app:
    image: "mediadepot/klaxon"
    links:
      - database
    depends_on:
      database:
        condition: service_healthy
    environment:
      RACK_ENV: "development"
      RAILS_ENV: "development"
      DATABASE_URL: "postgres://postgres@database/klaxon"
      SECRET_KEY_BASE: "secret_key_base"
    labels:
      - "traefik.enable=true"
      - "traefik.http.services.klaxon.loadbalancer.server.port=3000"
      - "traefik.http.routers.klaxon.rule=Host(`klaxon.${DEPOT_DOMAIN_NAME}`)"
      - 'traefik.http.routers.klaxon.entrypoints=websecure'
      - 'traefik.http.routers.klaxon.tls.certresolver=mydnschallenge'
    volumes:
      - /opt/mediadepot/apps/klaxon/app:/config
    networks:
      - traefik
      - klaxon
networks:
  traefik:
    external: true
  klaxon:

Or deploy it directly from the source:

git clone https://github.com/mediadepot/templates
cd templates
docker compose -f stacks/klaxon/docker-compose.yml up -d

More install options in our documentation.

Container Documentation

database Documentation

The PostgreSQL object-relational database system provides reliability and data integrity.

app Documentation

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 <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

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:1000 /opt/mediadepot/apps/klaxon/db (and the same for the other mapped folders)

Image won't pull

Test the pull directly on the host: docker pull postgres:11

  • "manifest unknown" means the tag no longer exists.
  • "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.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

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

A Compose stack

Klaxon is a Compose stack, a set of containers (2 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 2 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • database runs postgres:11
  • app runs mediadepot/klaxon, starts after database

Volumes

A volume is where Klaxon 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:

  • /var/lib/postgresql/data from /opt/mediadepot/apps/klaxon/db on the host
  • /config from /opt/mediadepot/apps/klaxon/app on the host

Environment variables

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

  • RACK_ENV, defaults to development
  • RAILS_ENV, defaults to development
  • DATABASE_URL, defaults to postgres://postgres@database/klaxon
  • SECRET_KEY_BASE, defaults to secret_key_base

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like database) while only the ports above are open to you.

Portainer app templates

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