Sign inSign up

savagesoftware/portainer-backup

By savagesoftware

•Updated about 4 years ago

Developed with ♥ by SavageSoftware, LLC. --- Script or Schedule Portainer backups.

Image
7

500K+

savagesoftware/portainer-backup repository overview

Docker NPM GitHub package.json version node-current portainer

⁠Portainer Backup

(Developed with ♥ by SavageSoftware, LLC.)

PLEASE FIND THE COMPLETE DOCUMENTATION HERE: https://github.com/SavageSoftware/portainer-backup⁠

⁠Overview

A utility for scripting or scheduling Portainer backups. This utility can backup the entire Portainer database, optionally protect the archive file with a password and can additionally backup the docker-compose files for stacks created in the Portainer web interface.

SCREENSHOT

PLEASE FIND THE COMPLETE DOCUMENTATION HERE: https://github.com/SavageSoftware/portainer-backup⁠

⁠TL;DR

DOCKER

Command to launch portainer-backup using a Docker container to perform a backup of your portainer server:

docker run -it --rm \
  --name portainer-backup \
  --volume $PWD/backup:/backup \
  --env PORTAINER_BACKUP_URL="http://portainer:9000" \
  --env PORTAINER_BACKUP_TOKEN="YOUR_ACCESS_TOKEN" \
  savagesoftware/portainer-backup:latest \
  backup

Command to launch portainer-backup using a Docker container to perform a scheduled backup of your portainer server:

docker run -it --rm \
  --name portainer-backup \
  --volume $PWD/backup:/backup \
  --env TZ="America/New_York" \
  --env PORTAINER_BACKUP_URL="http://portainer:9000" \
  --env PORTAINER_BACKUP_TOKEN="PORTAINER_ACCESS_TOKEN" \
  --env PORTAINER_BACKUP_OVERWRITE=true  \
  --env PORTAINER_BACKUP_DIRECTORY=/backup \
  --env PORTAINER_BACKUP_SCHEDULE="0 0 0 * * *" \
  savagesoftware/portainer-backup:latest \
  schedule

PLEASE FIND THE COMPLETE DOCUMENTATION HERE: https://github.com/SavageSoftware/portainer-backup⁠

⁠Docker Compose

Alternatively you can use a docker-compose.yml file to launch your portainer-backup container. Below is a sample docker-compose.yml file you can use to get started:

version: '3.8'
services:
  portainer-backup:
    container_name: portainer-backup
    image: savagesoftware/portainer-backup:latest
    hostname: portainer-backup
    restart: unless-stopped
    command: schedule
    environment:
      TZ: America/New_York
      PORTAINER_BACKUP_URL: "http://portainer:9000"
      PORTAINER_BACKUP_TOKEN: "PORTAINER_ACCESS_TOKEN"
      PORTAINER_BACKUP_PASSWORD: ""
      PORTAINER_BACKUP_OVERWRITE: 1
      PORTAINER_BACKUP_SCHEDULE: "0 0 0 * * *"
      PORTAINER_BACKUP_STACKS: 1
      PORTAINER_BACKUP_DRYRUN: 0
      PORTAINER_BACKUP_CONCISE: 1
      PORTAINER_BACKUP_DIRECTORY: "/backup"
      PORTAINER_BACKUP_FILENAME: "portainer-backup.tar.gz"
    volumes:
      - /var/backup:/backup

Just run the docker-compose up -d command in the same directory as your docker-compose.yml file to launch the container instance.

PLEASE FIND THE COMPLETE DOCUMENTATION HERE: https://github.com/SavageSoftware/portainer-backup⁠

Tag summary

Content type

Image

Digest

sha256:19cd1ab87…

Size

47.2 MB

Last updated

about 4 years ago

docker pull savagesoftware/portainer-backup