Backup

[diegoavelinogomes]

Hello!

How can I Backup all my Planka Data?

Thanks!

[meltyshev]

Hello!

Unfortunately there is no centralized script for backups right now.
If anyone has a good understanding of administration and how best to do backups (especially for Docker) - advice or PR is very welcome 🙂

There are 2 folders (server/public and server/private) with uploaded files and the database itself. So you need to copy these two folders and backup the database with pg_dump planka > planka.sql. But I don't yet understand how to do this better when using docker-compose...

[meltyshev]

To backup and restore the database when using docker-compose.

Backup: docker exec -t planka-postgres-1 pg_dumpall -c -U postgres > dump.sql.
Restore: cat dump.sql | docker exec -i planka-postgres-1 psql -U postgres.

[vsaw]

Here's a quick backup script I hacked together, it creates a full DB dump and takes all Avatars, Attachment and Backgrounds and compresses everything into a single tgz file

#!/bin/bash

# Stop on Error
set -e

PLANKA_DOCKER_CONTAINER_POSTGRES="planka_postgres_1"
PLANKA_DOCKER_CONTAINER_PLANKA="planka_planka_1"

BACKUP_DATETIME=$(date --utc +%FT%H-%M-%SZ)

# Dump DB into SQL File
echo -n "Dumping Database into temporary file $BACKUP_DATETIME-postgres.sql ..."
docker exec -t $PLANKA_DOCKER_CONTAINER_POSTGRES pg_dumpall -c -U postgres > $BACKUP_DATETIME-postgres.sql
echo " Success!"

# Export Docker Voumes
echo -n "Exporting user-avatars into temporary folder $BACKUP_DATETIME-user-avatars ..."
docker run --rm --volumes-from planka_planka_1 -v $(pwd):/backup ubuntu cp -r /app/public/user-avatars /backup/$BACKUP_DATETIME-user-avatars
echo " Success!"
echo -n "Exporting project-background-images into temporary folder $BACKUP_DATETIME-project-background-images ..."
docker run --rm --volumes-from planka_planka_1 -v $(pwd):/backup ubuntu cp -r /app/public/project-background-images /backup/$BACKUP_DATETIME-project-background-images
echo " Success!"
echo -n "Exporting attachments into temporary folder $BACKUP_DATETIME-attachments ..."
docker run --rm --volumes-from planka_planka_1 -v $(pwd):/backup ubuntu cp -r /app/private/attachments /backup/$BACKUP_DATETIME-attachments
echo " Success!"

# Create tgz
echo -n "Creating final tarball $BACKUP_DATETIME-backup.tgz ..."
tar -czf $BACKUP_DATETIME-backup.tgz $BACKUP_DATETIME-postgres.sql $BACKUP_DATETIME-user-avatars $BACKUP_DATETIME-project-background-images $BACKUP_DATETIME-attachments
echo " Success!"

#Remove source files
echo -n "Cleaning up temporary files and folders ..."
rm -rf $BACKUP_DATETIME-postgres.sql $BACKUP_DATETIME-user-avatars $BACKUP_DATETIME-project-background-images $BACKUP_DATETIME-attachments
echo " Success!"

echo "Backup Complete!"

To execute copy the script on the machine that runs Planka and call it using ./backup.sh. Upon successful execution you should see output similar to this:

$ ./backup.sh 
Dumping Database into temporary file 2023-01-16T16-16-14Z-postgres.sql ... Success!
Exporting user-avatars into temporary folder 2023-01-16T16-16-14Z-user-avatars ... Success!
Exporting project-background-images into temporary folder 2023-01-16T16-16-14Z-project-background-images ... Success!
Exporting attachments into temporary folder 2023-01-16T16-16-14Z-attachments ... Success!
Creating final tarball 2023-01-16T16-16-14Z-backup.tgz ... Success!
Cleaning up temporary files and folders ... Success!
Backup Complete!

I'm still working on a restore script, which I'm happy to share here as well. If there's enough interest I'd be happy to add a PR with my scripts once they are ready.

[meltyshev]

That's awesome!

[vsaw]

Backup and restore scripts are now officially available as of v1.10.2 https://github.com/plankanban/planka/releases/tag/v1.10.2