Update Plane version

Prerequisites

Before starting, make a backup of your Plane instance. For detailed steps, see the Backup data section. This is strongly recommended to ensure you have a safe restore point.

Update version

1. Download the latest stable release with ↓:

   curl -fsSL -o setup.sh https://raw.githubusercontent.com/makeplane/plane/master/deploy/selfhost/install.sh
   

2. Execute the setup script with ↓:

   ./setup.sh
   

   This will bring up a menu with several options. Select option 5 to upgrade:

   Select a 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]: 5
   

   Choosing this option stops all services and downloads the latest docker-compose.yaml and variables-upgrade.env files. The plane.env file won’t be overwritten, so your existing environment settings are safe.

   You’ll see a message indicating the services have been stopped.

3. After the update completes, select 6 to exit the prompt.

4. After the upgrade, open variables-upgrade.env and compare it with your plane.env file. Copy any new variables from variables-upgrade.env to your plane.env file and set the correct values. This step is essential to ensure that all configuration changes are in place for the latest version.

5. Once your plane.env file is updated, start your Plane instance again by selecting option 2.