Backup and restore data

Backup data

To create a backup, start by running the setup script:

./setup.sh

You’ll see a menu of options—just type 7 to select “Backup Data.”

Select an Action you want to perform:
   1) Install (x86_64)
   2) Start
   3) Stop
   4) Restart
   5) Upgrade
   6) View Logs
   7) Backup Data
   8) Exit

Action [2]: 7

The system will start backing up the PostgreSQL, Redis, and upload data:

Backing Up plane-app_pgdata
Backing Up plane-app_redisdata
Backing Up plane-app_uploads

Backup completed successfully. Backup files are stored in /....../plane-app/backup/20240502-1120

The backup files are stored locally, so you can copy them to an external storage service if needed for extra security.

Backup plane.env

If you need to back up only the plane.env file, you’ll need to do it manually. Here’s how:

1. Navigate to the folder on your machine or server where Plane is installed..
2. Locate the plane.env file.
3. Copy this file to a different location as a backup, so you can restore it if needed.

Restore data

Follow these steps to restore data from a backup:

1. Make sure Plane-CE is installed and started, then stop it. This ensures the necessary Docker volumes are ready.

2. Use the command ↓ to download the restore script. It’s easiest to save it in the same directory as setup.sh.

   curl -fsSL -o restore.sh https://raw.githubusercontent.com/makeplane/plane/master/deploy/selfhost/restore.sh
   chmod +x restore.sh
   

3. Now, run the command ↓ to restore your data, specifying the path to your backup folder (the folder with the *.tar.gz files):

   ./restore.sh <path to backup folder containing *.tar.gz files>
   

   Here’s an example output for restoring from /opt/plane-selfhost/plane-app/backup/20240722-0914:

       --------------------------------------------
       ____  _                          ///////// 
       |  _ \| | __ _ _ __   ___         ///////// 
       | |_) | |/ _` | '_ \ / _ \   /////    ///// 
       |  __/| | (_| | | | |  __/   /////    ///// 
       |_|   |_|\__,_|_| |_|\___|        ////      
                                       ////      
       --------------------------------------------
       Project management tool from the future
       --------------------------------------------
       Found /opt/plane-selfhost/plane-app/backup/20240722-0914/pgdata.tar.gz
       .....Restoring plane-app_pgdata
       .....Successfully restored volume plane-app_pgdata from pgdata.tar.gz
   
       Found /opt/plane-selfhost/plane-app/backup/20240722-0914/redisdata.tar.gz
       .....Restoring plane-app_redisdata
       .....Successfully restored volume plane-app_redisdata from redisdata.tar.gz
   
       Found /opt/plane-selfhost/plane-app/backup/20240722-0914/uploads.tar.gz
       .....Restoring plane-app_uploads
       .....Successfully restored volume plane-app_uploads from uploads.tar.gz
   
   
       Restore completed successfully.
   

4. Start your Plane instance again with ↓:

   ./setup.sh start
   

That’s it! You’re back up and running with your restored data.