Backup and restore data
Backing up your data regularly helps prevent data loss and allows you to restore your system quickly if necessary. Follow these instructions to back up and restore your data using Plane’s command-line interface.
Backup data
Create a backup of your Plane data with ↓:
This command initiates a full backup of all critical data, storing it in the default backup location at:
Each backup file will be timestamped to ensure you can easily identify the latest or a specific backup if needed.
Backup plane.env
If you need to back up only the plane.env
file, you’ll need to do it manually. Here’s how:
- Navigate to the
/opt/plane
folder on your machine or server where Plane is installed.. - Locate the
plane.env
file. - Copy this file to a different location as a backup, so you can restore it if needed.
Restore data
You can restore your data from a previous backup with ↓:
This command prompts the restoration process, which will overwrite the current data with the data from the most recent backup file. Ensure you have selected the correct backup before running this command, as restoring will replace your current data.
Community Edition
Community Edition
Backup data
To create a backup, start by running the setup script:
You’ll see a menu of options—just type 7 to select “Backup Data.”
The system will start backing up the PostgreSQL, Redis, and upload data:
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:
- Navigate to the folder on your machine or server where Plane is installed..
- Locate the
plane.env
file. - 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:
-
Make sure Plane-CE is installed and started, then stop it. This ensures the necessary Docker volumes are ready.
-
Use the command ↓ to download the restore script. It’s easiest to save it in the same directory as
setup.sh
. -
Now, run the command ↓ to restore your data, specifying the path to your backup folder (the folder with the
*.tar.gz
files):Here’s an example output for restoring from /opt/plane-selfhost/plane-app/backup/20240722-0914:
-
Start your Plane instance again with ↓:
That’s it! You’re back up and running with your restored data.