Portainer Templates logo

Portainer Templates

UrBackup UrBackup

Container

Backup

UrBackup is an easy to setup Open Source client/server backup system, that through a combination of image and file backups accomplishes both data safety and a fast restoration time.

Image details

Pulls: 24.8M
Architecture: amd64, arm64, arm/v7, 386, arm
Image size: 79 MB
Latest: 2.5.x-zfs
User: uroni
Created: Feb 20, 2018
Updated: 3 months ago
Status: active

Configuration

Type
Container
Platform
linux
Image
uroni/urbackup-server:latest
Ports
55415:55415/tcp55414:55414/tcp
Volumes
/var/urbackup : /portainer/Files/AppData/Config/urbackup/backup : /portainer/backups
Env vars
PUID=1000PGID=1000
Restart
unless-stopped

Template by novaspirit

Notes

Template created by Pi-Hosted Series
Check our Github page: https://github.com/pi-hosted/pi-hosted

Official Webpage: https://www.urbackup.org/
Official Docker Documentation: https://www.github.com/uroni/urbackup-server-docker


Standalone Install

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

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 UrBackup, 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.

Multiarch (amd64/arm64(aarch64)) docker images for UrBackup server.

Pulling the :latest tag should automatically grab the right image for your arch.
Most of the original code is based on the image by Whatang

Running

If you want to use docker run command:

For PGID and PUID please enter the UID/GID of the user who should own the files outside the container.
docker run -d \
                --name urbackup \
                --restart unless-stopped \
                -e PUID=1000 \  
                -e PGID=100  \
                -e TZ=Europe/Berlin \
                -v /path/to/your/backup/folder:/backups \
                -v /path/to/your/database/folder:/var/urbackup \
                --network host \
                uroni/urbackup-server:latest

For BTRFS-Support add --cap-add SYS_ADMIN to the command above
For ZFS support add --device /dev/zfs to the command above
Add -e ZFS_IMAGE=tank/images and -e ZFS_FILES=tank/files to the command above if you want to set the ZFS dataset via an ENV variable instead of mounting /etc/urbackup/dataset*
If you want to externally bind-mount the www-folder add -v /path/to/wwwfolder:/usr/share/urbackup

Or via docker-compose (compatible with stacks in Portainer):

docker-compose.yml 
version: '2'

services:
  urbackup:
    image: uroni/urbackup-server:latest
    container_name: urbackup
    restart: unless-stopped
    environment:
      - PUID=1000 # Enter the UID of the user who should own the files here
      - PGID=100  # Enter the GID of the user who should own the files here
      - TZ=Europe/Berlin # Enter your timezone
      # Uncomment the next lines if you want to set the ZFS datasets via ENV variables instead of mounting /etc/urbackup/dataset*
      #- ZFS_IMAGE=tank/images
      #- ZFS_FILES=tank/files
    volumes:
      - /path/to/your/database/folder:/var/urbackup
      - /path/to/your/backup/folder:/backups
      # Uncomment the next line if you want to bind-mount the www-folder
      #- /path/to/wwwfolder:/usr/share/urbackup
    network_mode: "host"
    # Uncomment the following two lines if you're using BTRFS support
    #cap_add:
    #  - SYS_ADMIN
    # Uncomment the following two lines if you're using ZFS support
    #devices:
    #  - /dev/zfs:/dev/zfs
  
```              
	     
After running the container Urbackup should be reachable on the web interface on port :55414	     

## Building locally
Please use the provided `build.sh` script:
./build.sh 
On default the script will build a container for amd64 with the most recent stable version.

To build for other architectures the script accepts following argument:
`./build.sh [ARCH] [VERSION]`

`[ARCH]` can be `amd64`, `i386`, `armhf` or `arm64`; `[Version]` can be an existing version of UrBackup-server

For example if you want to build an image for version 2.4.10 on armhf use the following command:
./build.sh armhf 2.4.10 ```

Serve UrBackup 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 urbackup.example.com to http://UrBackup:55415

Add this to your Caddyfile

urbackup.example.com {
	reverse_proxy http://UrBackup:55415
}

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 UrBackup
  • 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:55415 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :55415
  • Stop the other service, or pick a different host port. In 55415:55415 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:55415. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, UrBackup can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 55415

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/urbackup (and the same for the other mapped folders)
  • Or set the PUID and PGID variables (defaults 1000:1000) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull uroni/urbackup-server:latest

  • "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, 386, arm
  • 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 UrBackup --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

UrBackup 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 UrBackup needs bundled into one download. This template pulls uroni/urbackup-server:latest, which Docker fetches once (about 79 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. UrBackup's comes from Docker Hub, published by uroni.

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 2.5.x-zfs. 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, 386, arm, 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 55415:55415 means it's reachable on port 55415 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 55415:55415
  • 55414:55414

Volumes

A volume is where UrBackup 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/urbackup from /portainer/Files/AppData/Config/urbackup on the host
  • /backup from /portainer/backups on the host

Environment variables

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

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

Restart policy

The restart policy here is unless-stopped, so Docker restarts UrBackup 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).

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 UrBackup 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 UrBackup. That's what you'll spot in the containers list and use in commands like docker logs UrBackup.

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