Portainer Templates logo

Portainer Templates

Databag Databag

Stack

MessagingSocial

A lightweight federated messaging service. Source: https://github.com/balzack/databag

Image details

Pulls: 160k
Architecture: amd64, arm64
Image size: 229 MB
Latest: 0.1.18
User: balzack
Created: Jun 10, 2022
Updated: 10 months ago
Status: active

Source details

Stars: 1k
Forks: 93
Language: TypeScript
License: Apache-2.0
Updated: 2 months ago

Configuration

Type
Compose
Platform
linux
Image
balzack/databag:0.1.18
Ports
7000:7000
Volumes
/var/lib/databag : databag-data
Env vars
ADMIN=${DATABAG_ADMIN_PASSWORD}DATABAG_ADMIN_PASSWORD=
Restart
unless-stopped
Source

Source

Notes

After deploy, open the app, click the settings gear, enter your admin password, set the Federated Host, then use the user icon to create account-registration links.

Standalone Install

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

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 Databag, 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:
  databag:
    container_name: databag
    image: balzack/databag:0.1.18
    restart: unless-stopped
    ports:
      - "7000:7000"
    environment:
      # Password for the admin dashboard (set the Federated Host + account links there)
      - ADMIN=${DATABAG_ADMIN_PASSWORD}
    volumes:
      - databag-data:/var/lib/databag

volumes:
  databag-data:

Or deploy it directly from the source:

git clone https://github.com/lissy93/portainer-templates
cd portainer-templates
docker compose -f sources/stacks/databag.yml up -d

More install options in our documentation, or see balzack/databag for app-specific guidance.

Tags:
\ - incremental releases
latest - latest tested version
Optional environment variables:
ADMIN - value for the admin password
DEV - set to 1 if server should launch manually
Please post any issues or requests to: https://github.com/balzack/databag/discussions

Serve Databag 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 databag.example.com to http://databag:7000

Add this to your Caddyfile

databag.example.com {
	reverse_proxy http://databag:7000
}

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.

Port already in use

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

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

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:7000. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, databag can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 7000

Image won't pull

Test the pull directly on the host: docker pull balzack/databag:0.1.18

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

  • This image supports: amd64, arm64
  • 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 unless-stopped 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.

Required settings are blank

DATABAG_ADMIN_PASSWORD has no default value, and databag may crash or misbehave if left empty.

  • Fill it in on the deploy screen before hitting deploy.

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

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

The app image

An image is the app packed up ready to go, everything Databag needs bundled into one download. This template pulls balzack/databag:0.1.18, which Docker fetches once (about 229 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. Databag's comes from Docker Hub, published by balzack.

Version tags

The bit after the colon in the image name is the version tag. This one pins 0.1.18, so every redeploy gives you that exact build until you bump it yourself.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, 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 7000:7000 means it's reachable on port 7000 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 7000:7000

Volumes

A volume is where Databag 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/databag kept in the databag-data volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Databag takes 2 of them, and one needs a value before it'll start properly:

  • ADMIN, pulled from your own environment
  • DATABAG_ADMIN_PASSWORD, needs a value. Admin dashboard password

Restart policy

The restart policy here is unless-stopped, so Docker restarts Databag after a crash or reboot, but leaves it off when you stop it on purpose. 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

Nothing custom is set, so Databag 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 databag. That's what you'll spot in the containers list and use in commands like docker logs databag.

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.

Open source license

Databag is open source, released under the Apache-2.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

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