Mandatory checkpoint at v0.14.0 • Community Edition
If you’re upgrading from v0.13.2
or below, there are some additional migration
steps due to significant changes in the self-hosting setup. Follow these
instructions to migrate your data to the new volume structure in v0.14.0
.
-
First, stop the running
v0.13-2
(or older) instance of Plane. If it's still running, you might hit a "ports not available" error, which will prevent thev0.14-0
containers from starting up correctly.docker compose down
-
Create a new folder for
v0.14-0
to ensure a clean installation.mkdir plane-selfhost
cd plane-selfhost -
Set up the environment variable for the
RELEASE
variable, then download and prepare the installation script:export RELEASE=v0.14-dev
curl -fsSL https://raw.githubusercontent.com/makeplane/plane/master/deploy/selfhost/install.sh | \
sed -e 's@BRANCH=${BRANCH:-master}@BRANCH='"$RELEASE"'@' -e 's@APP_RELEASE="stable"@APP_RELEASE='"$RELEASE"'@' > setup.sh
chmod +x setup.sh -
Execute the script to install Plane:
./setup.sh install
-
Start up your new v0.14-0 Plane instance:
./setup.sh start
-
Now stop the instance to initialize the new Docker volumes:
./setup.sh stop
-
Download the migration script:
curl -fsSL -o migrate.sh https://raw.githubusercontent.com/makeplane/plane/master/deploy/selfhost/migration-0.13-0.14.sh
chmod +x migrate.sh -
Run the migration script:
./migrate.sh
You’ll see the following instructions:
******************************************************************
This script is solely for the migration purpose only.
This is a one-time migration of volume data from v0.13.2 => v0.14.x
Assumptions:
1. Postgres data volume name ends with _pgdata
2. Minio data volume name ends with _uploads
3. Redis data volume name ends with _redisdata
Any changes to this script can break the migration.
Before you proceed, make sure you run the below command to know the docker
volumes:
docker volume ls -q | grep -i "_pgdata"
docker volume ls -q | grep -i "_uploads"
docker volume ls -q | grep -i "_redisdata"
*******************************************************
Given below list of REDIS volumes, identify the prefix of source and destination volumes leaving "_redisdata"
---------------------
plane-app_redisdata
v0132_redisdata
Provide the Source Volume Prefix : -
Open a second terminal and run the commands shown above to identify your source and destination volume prefixes. For example, if you run
docker volume ls -q | grep -i "_pgdata"
, you might see something like:In this example,
plane-013-dev
is the prefix forv0.13.2
, andplane-app
is the prefix forv0.14.0
. -
Return to the original terminal, enter the source volume prefix
plane-013-dev
and destination volume prefixplane-app
, and press ENTER:Provide the Source Volume Prefix : plane-013-dev
Provide the Destination Volume Prefix : plane-appIf there are any issues, an error will appear. For a successful migration, there will be no error, and the process will exit quietly.
-
Restart the upgraded v0.14.0 instance with:
./setup.sh restart
-
Login as instance admin by appending
/god-mode
to your domain. -
Once logged in, just click Save Changes to finalize your setup.
-
You’re all set! Log in to your updated
v0.14-0
instance to check if all of your data has migrated successfully.