Portainer Templates logo

Portainer Templates

Wallabag Wallabag

Stack

Tools

wallabag is a web application allowing you to save web pages for later reading. Click, save and read it when you want.

Configuration

Type
Compose
Platform
linux
Ports
8234:80/tcp
Restart
always
Source
Repo

Template by xneo1·Source

Services

wallabag

Configuration

Image
wallabag/wallabag
Ports
1180
Volumes
/var/www/wallabag/web/assets/images : /portainer/Files/AppData/Config/wallabag/images
Env vars
MYSQL_ROOT_PASSWORD=wallarootSYMFONY__ENV__DATABASE_DRIVER=pdo_mysqlSYMFONY__ENV__DATABASE_HOST=dbSYMFONY__ENV__DATABASE_PORT=3306SYMFONY__ENV__DATABASE_NAME=wallabagSYMFONY__ENV__DATABASE_USER=wallabagSYMFONY__ENV__DATABASE_PASSWORD=wallapassSYMFONY__ENV__DATABASE_CHARSET=utf8mb4SYMFONY__ENV__DATABASE_TABLE_PREFIX="wallabag_"SYMFONY__ENV__MAILER_HOST=127.0.0.1SYMFONY__ENV__MAILER_USER=~SYMFONY__ENV__MAILER_PASSWORD=~SYMFONY__ENV__FROM_EMAIL=wallabag@example.comSYMFONY__ENV__DOMAIN_NAME=https://your-wallabag-url-instance.comSYMFONY__ENV__SERVER_NAME="Your wallabag instance"

Image details

Pulls: 68.6M
User: wallabag
Created: Apr 19, 2016
Updated: 10 months ago
Status: active

wallabag-db

Configuration

Image
mariadb
Volumes
/var/lib/mysql : /portainer/Files/AppData/Config/wallabag/data
Env vars
MYSQL_ROOT_PASSWORD=wallaroot

Image details

Pulls: 3.2B
User: stackbrew
Created: Nov 25, 2014
Updated: 2 days ago
Status: active

wallabag-redis

Configuration

Image
redis:alpine

Image details

Pulls: 11.1B
User: stackbrew
Created: Jun 05, 2014
Updated: 9 days ago
Status: active

Standalone Install

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

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 Wallabag, 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:

services:
  wallabag:
    image: wallabag/wallabag
    environment:
      - MYSQL_ROOT_PASSWORD=wallaroot
      - SYMFONY__ENV__DATABASE_DRIVER=pdo_mysql
      - SYMFONY__ENV__DATABASE_HOST=db
      - SYMFONY__ENV__DATABASE_PORT=3306
      - SYMFONY__ENV__DATABASE_NAME=wallabag
      - SYMFONY__ENV__DATABASE_USER=wallabag
      - SYMFONY__ENV__DATABASE_PASSWORD=wallapass
      - SYMFONY__ENV__DATABASE_CHARSET=utf8mb4
      - SYMFONY__ENV__DATABASE_TABLE_PREFIX="wallabag_"
      - SYMFONY__ENV__MAILER_HOST=127.0.0.1
      - SYMFONY__ENV__MAILER_USER=~
      - SYMFONY__ENV__MAILER_PASSWORD=~
      - SYMFONY__ENV__FROM_EMAIL=wallabag@example.com
      - SYMFONY__ENV__DOMAIN_NAME=https://your-wallabag-url-instance.com
      - SYMFONY__ENV__SERVER_NAME="Your wallabag instance"
    ports:
      - "1180"
    volumes:
      - /portainer/Files/AppData/Config/wallabag/images:/var/www/wallabag/web/assets/images
    healthcheck:
      test: ["CMD", "wget" ,"--no-verbose", "--tries=1", "--spider", "http://localhost"]
      interval: 1m
      timeout: 3s
    depends_on:
      - wallabag-db
      - wallabag-redis
  wallabag-db:
    image: mariadb
    environment:
      - MYSQL_ROOT_PASSWORD=wallaroot
    volumes:
      - /portainer/Files/AppData/Config/wallabag/data:/var/lib/mysql
    healthcheck:
      test: ["CMD", "mysqladmin" ,"ping", "-h", "localhost"]
      interval: 20s
      timeout: 3s
  wallabag-redis:
    image: redis:alpine
    healthcheck:
      test: ["CMD", "redis-cli", "ping"]
      interval: 20s
      timeout: 3s

Or deploy it directly from the source:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/wallabag.yml up -d

More install options in our documentation.

Container Documentation

wallabag Documentation

Official docker-composer for wallabag.

wallabag-db Documentation

MariaDB Server is a high performing open source relational database, forked from MySQL.

wallabag-redis Documentation

Redis is the world’s fastest data platform for caching, vector search, and NoSQL databases.

Serve Wallabag on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying wallabag.example.com to http://wallabag:1180

Add this to your Caddyfile

wallabag.example.com {
	reverse_proxy http://wallabag:1180
}

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.

Published on a random port

This template exposes 1180 without setting a host port, so Docker picks a random free one on every deploy.

  • Find it in the Ports column of Portainer's container list, or with docker port <container>

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 /portainer/Files/AppData/Config/wallabag/images (and the same for the other mapped folders)

Image won't pull

Test the pull directly on the host: docker pull wallabag/wallabag

  • "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.

  • 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 <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

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

Wallabag is a Compose stack, a set of containers (3 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 3 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • wallabag runs wallabag/wallabag, starts after wallabag-db, wallabag-redis
  • wallabag-db runs mariadb
  • wallabag-redis runs redis:alpine

Ports

A port is the door the app answers on. Here the app exposes a port but leaves the host side blank, so Docker picks a free one for you. It opens:

  • 1180, published on a random host port

Volumes

A volume is where Wallabag 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/www/wallabag/web/assets/images from /portainer/Files/AppData/Config/wallabag/images on the host
  • /var/lib/mysql from /portainer/Files/AppData/Config/wallabag/data on the host

Environment variables

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

  • MYSQL_ROOT_PASSWORD, defaults to wallaroot
  • SYMFONY__ENV__DATABASE_DRIVER, defaults to pdo_mysql
  • SYMFONY__ENV__DATABASE_HOST, defaults to db
  • SYMFONY__ENV__DATABASE_PORT, defaults to 3306
  • SYMFONY__ENV__DATABASE_NAME, defaults to wallabag
  • SYMFONY__ENV__DATABASE_USER, defaults to wallabag
  • SYMFONY__ENV__DATABASE_PASSWORD, defaults to wallapass
  • SYMFONY__ENV__DATABASE_CHARSET, defaults to utf8mb4
  • SYMFONY__ENV__DATABASE_TABLE_PREFIX, defaults to "wallabag_"
  • SYMFONY__ENV__MAILER_HOST, defaults to 127.0.0.1
  • SYMFONY__ENV__MAILER_USER, defaults to ~
  • SYMFONY__ENV__MAILER_PASSWORD, defaults to ~
  • SYMFONY__ENV__FROM_EMAIL, defaults to wallabag@example.com
  • SYMFONY__ENV__DOMAIN_NAME, defaults to https://your-wallabag-url-instance.com
  • SYMFONY__ENV__SERVER_NAME, defaults to "Your wallabag instance"

Restart policy

The restart policy here is always, so Docker brings Wallabag 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).

Networking

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

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 Wallabag up. Add the template list to Portainer once, then deploying Wallabag is a click rather than a wall of config.