diff --git a/self-hosting/methods/docker-compose.mdx b/self-hosting/methods/docker-compose.mdx index 2113662..03e6f65 100644 --- a/self-hosting/methods/docker-compose.mdx +++ b/self-hosting/methods/docker-compose.mdx @@ -32,7 +32,7 @@ Ensure you're using the **latest version of Docker Compose**. Check your Docker curl -fsSL https://prime.plane.so/install/ | sh - ``` 3. Follow the instructions on the terminal. Hit `Enter` or `Return` to continue. - 4. Enter the domain name where you will access the Plane app in the format `domain.tld` or `subdomain.domain.tld`. If you are using a paid plan, the domain linked to the license can’t be changed later. + 4. Enter the domain name where you will access the Plane app in the format `domain.tld` or `subdomain.domain.tld`. 5. Choose one of the options below: - **Express**: Plane installs with the default configurations. - **Advanced**: You can customize the database, Redis, storage and other settings. diff --git a/self-hosting/upgrade-from-community.mdx b/self-hosting/upgrade-from-community.mdx index a95b593..ccaa45f 100644 --- a/self-hosting/upgrade-from-community.mdx +++ b/self-hosting/upgrade-from-community.mdx @@ -6,9 +6,6 @@ The Commercial edition comes with the free plan and the flexibility to upgrade t **IMPORTANT** - -Make sure you already have Commercial Edition installed on a fresh machine before starting this migration. If you haven’t installed it yet, follow our [Commercial Edition](/self-hosting/methods/docker-compose#recommended-edition) installation guide first. - The instructions provided on this page are specific to installations using Docker. If you are running Plane on Kubernetes, you'll need to manually create a database dump and back up your file storage by copying the relevant volumes or storage paths. @@ -16,48 +13,104 @@ The instructions provided on this page are specific to installations using Docke - Install the [Commercial Edition](/self-hosting/methods/docker-compose#recommended-edition) on a fresh machine, not the one running the Plane Community Edition. - Be sure to log in as the root user or as a user with sudo access. The `/opt` folder requires sudo or root privileges. -## Back up data on Community instance -1. Download the latest version of `setup.sh`. - ```bash - curl -fsSL https://github.com/makeplane/plane/releases/latest/download/setup.sh -o setup.sh - ``` - -2. Run the setup.sh backup script to take the backup of the Community Edition instance. - ```bash - ./setup.sh backup - ``` -3. When done, your data will be backed up to the folder shown on the screen. - e.g., `/plane-selfhost/plane-app/backup/20240522-1027` - This folder will contain 3 `tar.gz` files. - - `pgdata.tar.gz` - - `redisdata.tar.gz` - - `uploads.tar.gz` - -4. Copy all the three files from the server running the Community Edition to any folder on the server running the Commercial Edition. - - e.g., `~/ce-backup` - -## Restore data on Commercial instance -1. Start any command-line interface like Terminal and go into the folder with the back-up files. - ``` - cd ~/ce-backup - ``` -2. Copy and paste the script below on Terminal and hit Enter. - ``` - TARGET_DIR=/opt/plane/data - sudo mkdir -p $TARGET_DIR - for FILE in *.tar.gz; do - if [ -e "$FILE" ]; then - tar -xzvf "$FILE" -C "$TARGET_DIR" - else - echo "No .tar.gz files found in the current directory." - exit 1 - fi - done - - mv $TARGET_DIR/pgdata/ $TARGET_DIR/db - mv $TARGET_DIR/redisdata/ $TARGET_DIR/redis - mkdir -p $TARGET_DIR/minio - mv $TARGET_DIR/uploads/ $TARGET_DIR/minio/uploads/ - ``` -3. This script will extract your Community Edition data and restore it to `/opt/plane/data`. + + + + This upgrade path is for installations using Plane's default PostgreSQL database and MinIO object storage. + + + ## Back up data on Community instance + 1. Download the latest version of `setup.sh`. + ```bash + curl -fsSL https://github.com/makeplane/plane/releases/latest/download/setup.sh -o setup.sh + ``` + + 2. Run the setup.sh backup script to take the backup of the Community Edition instance. + ```bash + ./setup.sh backup + ``` + 3. When done, your data will be backed up to the folder shown on the screen. + e.g., `/plane-selfhost/plane-app/backup/20240522-1027` + This folder will contain 3 `tar.gz` files. + - `pgdata.tar.gz` + - `redisdata.tar.gz` + - `uploads.tar.gz` + + 4. Copy all the three files from the server running the Community Edition to any folder on the server running the Commercial Edition. + + e.g., `~/ce-backup` + + ## Restore data on Commercial instance + 1. Start any command-line interface like Terminal and go into the folder with the back-up files. + ``` + cd ~/ce-backup + ``` + 2. Copy and paste the script below on Terminal and hit Enter. + ``` + TARGET_DIR=/opt/plane/data + sudo mkdir -p $TARGET_DIR + for FILE in *.tar.gz; do + if [ -e "$FILE" ]; then + tar -xzvf "$FILE" -C "$TARGET_DIR" + else + echo "No .tar.gz files found in the current directory." + exit 1 + fi + done + + mv $TARGET_DIR/pgdata/ $TARGET_DIR/db + mv $TARGET_DIR/redisdata/ $TARGET_DIR/redis + mkdir -p $TARGET_DIR/minio + mv $TARGET_DIR/uploads/ $TARGET_DIR/minio/uploads/ + ``` + 3. This script will extract your Community Edition data and restore it to `/opt/plane/data`. + + + + + This upgrade path is for installations using external or managed database and object storage services (like AWS RDS and S3). Since your data already lives in external services, you only need to update your configuration — no backup and restore required. + + ## Update configuration for Commercial Edition + + 1. Open the `plane.env` file located at `/opt/plane/plane.env`. + + 2. Configure database connection. + + 1. Find the `DATABASE_URL` environment variable. + 2. Verify it points to your external database: + ```env + DATABASE_URL=postgresql://user:password@your-db-host:5432/plane + ``` + + If you need to change it, update the value with your managed database connection string. + + 3. Configure object storage + + 1. Find the `#DATASTORE SETTINGS` section in `plane.env` + 2. Update these environment variables for your external storage: + ```env + USE_MINIO=0 + AWS_REGION=us-east-1 + AWS_ACCESS_KEY_ID= + AWS_SECRET_ACCESS_KEY= + AWS_S3_ENDPOINT_URL=https://s3.amazonaws.com + AWS_S3_BUCKET_NAME=plane-uploads + ``` + + :::info + Setting `USE_MINIO=0` disables the local MinIO service and enables external object storage (S3 or S3-compatible services). + ::: + + 4. Restart Plane services to apply the configuration: + ```bash + prime-cli restart + ``` + + Your Commercial Edition instance is now connected to your existing external database and storage. + + + + +## What's next + +- [Activate a paid plan license](/self-hosting/manage/manage-licenses). \ No newline at end of file