Merge pull request #1519 from onionrings29/feat/add-plane

feat: add Plane LXC helper script
2026-03-25 08:42:51 +01:00
parent a794aa7fcc c5177f0e37
commit 8c47039d0f
3 changed files with 526 additions and 0 deletions
--- a/ct/plane.sh
+++ b/ct/plane.sh
@@ -0,0 +1,96 @@
+#!/usr/bin/env bash
+source <(curl -s https://raw.githubusercontent.com/community-scripts/ProxmoxVED/main/misc/build.func)
+# Copyright (c) 2021-2026 community-scripts ORG
+# Author: onionrings29
+# License: MIT | https://github.com/community-scripts/ProxmoxVED/raw/main/LICENSE
+# Source: https://plane.so | GitHub: https://github.com/makeplane/plane
+
+APP="Plane"
+var_tags="${var_tags:-project-management}"
+var_cpu="${var_cpu:-2}"
+var_ram="${var_ram:-4096}"
+var_disk="${var_disk:-8}"
+var_os="${var_os:-debian}"
+var_version="${var_version:-13}"
+var_unprivileged="${var_unprivileged:-1}"
+
+header_info "$APP"
+variables
+color
+catch_errors
+
+function update_script() {
+  header_info
+  check_container_storage
+  check_container_resources
+
+  if [[ ! -d /opt/plane ]]; then
+    msg_error "No Plane Installation Found!"
+    exit 1
+  fi
+
+  if check_for_gh_release "plane" "makeplane/plane"; then
+    msg_info "Stopping Services"
+    systemctl stop plane-api plane-worker plane-beat plane-live plane-space
+    msg_ok "Stopped Services"
+
+    msg_info "Backing up Data"
+    cp /opt/plane/apps/api/.env /opt/plane-api-env.bak
+    cp /opt/plane/.env /opt/plane-live-env.bak
+    cp /opt/plane/apps/web/.env /opt/plane-web-env.bak
+    cp /opt/plane/apps/admin/.env /opt/plane-admin-env.bak
+    cp /opt/plane/apps/space/.env /opt/plane-space-env.bak
+    msg_ok "Backed up Data"
+
+    CLEAN_INSTALL=1 fetch_and_deploy_gh_release "plane" "makeplane/plane" "tarball"
+
+    msg_info "Restoring Config"
+    cp /opt/plane-api-env.bak /opt/plane/apps/api/.env
+    cp /opt/plane-live-env.bak /opt/plane/.env
+    cp /opt/plane-web-env.bak /opt/plane/apps/web/.env
+    cp /opt/plane-admin-env.bak /opt/plane/apps/admin/.env
+    cp /opt/plane-space-env.bak /opt/plane/apps/space/.env
+    rm -f /opt/plane-api-env.bak /opt/plane-live-env.bak /opt/plane-web-env.bak /opt/plane-admin-env.bak /opt/plane-space-env.bak
+    msg_ok "Restored Config"
+
+    msg_info "Rebuilding Frontend (Patience)"
+    cd /opt/plane
+    export NODE_OPTIONS="--max-old-space-size=4096"
+    export COREPACK_ENABLE_DOWNLOAD_PROMPT=0
+    $STD corepack enable pnpm
+    $STD pnpm install --frozen-lockfile
+    $STD pnpm turbo run build --filter=web --filter=admin --filter=space --filter=live
+    msg_ok "Rebuilt Frontend"
+
+    msg_info "Updating Python Dependencies"
+    cd /opt/plane/apps/api
+    export VIRTUAL_ENV=/opt/plane-venv
+    $STD uv pip install --upgrade -r requirements/production.txt
+    msg_ok "Updated Python Dependencies"
+
+    msg_info "Running Migrations"
+    cd /opt/plane/apps/api
+    set -a
+    source /opt/plane/apps/api/.env
+    set +a
+    $STD /opt/plane-venv/bin/python manage.py migrate
+    $STD /opt/plane-venv/bin/python manage.py collectstatic --noinput
+    $STD /opt/plane-venv/bin/python manage.py configure_instance
+    msg_ok "Ran Migrations"
+
+    msg_info "Starting Services"
+    systemctl start plane-api plane-worker plane-beat plane-live plane-space
+    msg_ok "Started Services"
+    msg_ok "Updated successfully!"
+  fi
+  exit
+}
+
+start
+build_container
+description
+
+msg_ok "Completed successfully!\n"
+echo -e "${CREATING}${GN}${APP} setup has been successfully initialized!${CL}"
+echo -e "${INFO}${YW} Access it using the following URL:${CL}"
+echo -e "${TAB}${GATEWAY}${BGN}http://${IP}${CL}"
--- a/frontend/public/json/plane.json
+++ b/frontend/public/json/plane.json
@@ -0,0 +1,52 @@
+{
+  "name": "Plane",
+  "slug": "plane",
+  "categories": [
+    25
+  ],
+  "date_created": "2026-02-25",
+  "type": "ct",
+  "updateable": true,
+  "privileged": false,
+  "interface_port": 80,
+  "documentation": "https://developers.plane.so/self-hosting/overview",
+  "website": "https://plane.so",
+  "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/plane.webp",
+  "config_path": "/opt/plane/apps/api/.env",
+  "description": "Open-source project tracking tool that helps teams plan, track, and manage their software projects with issues, cycles, and modules.",
+  "install_methods": [
+    {
+      "type": "default",
+      "script": "ct/plane.sh",
+      "resources": {
+        "cpu": 2,
+        "ram": 4096,
+        "hdd": 8,
+        "os": "Debian",
+        "version": "13"
+      }
+    }
+  ],
+  "default_credentials": {
+    "username": null,
+    "password": null
+  },
+  "notes": [
+    {
+      "text": "First user to sign up becomes the instance admin. Initial build takes 10-15 minutes.",
+      "type": "info"
+    },
+    {
+      "text": "Admin panel (God Mode) is available at `/god-mode/` for instance configuration.",
+      "type": "info"
+    },
+    {
+      "text": "Credentials are saved to `~/plane.creds`.",
+      "type": "info"
+    },
+    {
+      "text": "If the container IP changes, rebuild the frontend apps or run the update script to apply the new URL.",
+      "type": "warning"
+    }
+  ]
+}
--- a/install/plane-install.sh
+++ b/install/plane-install.sh
@@ -0,0 +1,378 @@
+#!/usr/bin/env bash
+
+# Copyright (c) 2021-2026 community-scripts ORG
+# Author: onionrings29
+# License: MIT | https://github.com/community-scripts/ProxmoxVED/raw/main/LICENSE
+# Source: https://plane.so
+
+source /dev/stdin <<<"$FUNCTIONS_FILE_PATH"
+color
+verb_ip6
+catch_errors
+setting_up_container
+network_check
+update_os
+
+msg_info "Installing Dependencies"
+$STD apt install -y \
+  nginx \
+  build-essential \
+  libpq-dev \
+  libxml2-dev \
+  libxslt1-dev \
+  libxmlsec1-dev \
+  libxmlsec1-openssl \
+  pkg-config \
+  python3-dev \
+  python3-venv \
+  redis-server \
+  erlang-base \
+  erlang-{asn1,crypto,eldap,ftp,inets,mnesia,os-mon,parsetools} \
+  erlang-{public-key,runtime-tools,snmp,ssl,syntax-tools,tftp,tools,xmerl} \
+  rabbitmq-server
+msg_ok "Installed Dependencies"
+
+NODE_VERSION="22" setup_nodejs
+PG_VERSION="16" setup_postgresql
+PG_DB_NAME="plane" PG_DB_USER="plane" setup_postgresql_db
+
+msg_info "Configuring RabbitMQ"
+RABBITMQ_PASS=$(openssl rand -base64 24 | tr -dc 'a-zA-Z0-9' | head -c16)
+$STD rabbitmqctl add_vhost plane
+$STD rabbitmqctl add_user plane "${RABBITMQ_PASS}"
+$STD rabbitmqctl set_permissions -p plane plane ".*" ".*" ".*"
+msg_ok "Configured RabbitMQ"
+
+msg_info "Installing MinIO"
+curl -fsSL https://dl.min.io/server/minio/release/linux-amd64/minio -o /usr/local/bin/minio
+chmod +x /usr/local/bin/minio
+mkdir -p /opt/minio/data
+MINIO_ACCESS_KEY=$(openssl rand -base64 18 | tr -dc 'a-zA-Z0-9' | head -c16)
+MINIO_SECRET_KEY=$(openssl rand -base64 36 | tr -dc 'a-zA-Z0-9' | head -c32)
+cat <<EOF >/etc/default/minio
+MINIO_ROOT_USER="${MINIO_ACCESS_KEY}"
+MINIO_ROOT_PASSWORD="${MINIO_SECRET_KEY}"
+MINIO_VOLUMES="/opt/minio/data"
+EOF
+cat <<EOF >/etc/systemd/system/minio.service
+[Unit]
+Description=MinIO Object Storage
+After=network.target
+
+[Service]
+Type=simple
+EnvironmentFile=/etc/default/minio
+ExecStart=/usr/local/bin/minio server \$MINIO_VOLUMES --console-address ":9090"
+Restart=on-failure
+RestartSec=5
+
+[Install]
+WantedBy=multi-user.target
+EOF
+systemctl enable -q --now minio
+msg_ok "Installed MinIO"
+
+fetch_and_deploy_gh_release "plane" "makeplane/plane" "tarball"
+
+msg_info "Building Frontend Apps (Patience)"
+cd /opt/plane
+FRONTEND_ENV="VITE_API_BASE_URL=http://${LOCAL_IP}
+VITE_WEB_BASE_URL=http://${LOCAL_IP}
+VITE_ADMIN_BASE_URL=http://${LOCAL_IP}
+VITE_ADMIN_BASE_PATH=/god-mode
+VITE_SPACE_BASE_URL=http://${LOCAL_IP}
+VITE_SPACE_BASE_PATH=/spaces
+VITE_LIVE_BASE_URL=http://${LOCAL_IP}
+VITE_LIVE_BASE_PATH=/live"
+# Each Vite app needs its own .env for the build
+for app in web admin space; do
+  echo "$FRONTEND_ENV" >/opt/plane/apps/${app}/.env
+done
+export NODE_OPTIONS="--max-old-space-size=4096"
+export COREPACK_ENABLE_DOWNLOAD_PROMPT=0
+$STD corepack enable pnpm
+$STD pnpm install --frozen-lockfile
+$STD pnpm turbo run build --filter=web --filter=admin --filter=space --filter=live
+msg_ok "Built Frontend Apps"
+
+msg_info "Setting up Python API"
+setup_uv
+$STD uv venv /opt/plane-venv
+export VIRTUAL_ENV=/opt/plane-venv
+$STD uv pip install -r /opt/plane/apps/api/requirements/production.txt
+msg_ok "Set up Python API"
+
+msg_info "Configuring Plane"
+SECRET_KEY=$(openssl rand -hex 32)
+MACHINE_SIG=$(echo -n "$(hostname)-$(date +%s)" | sha256sum | head -c64)
+LIVE_SECRET=$(openssl rand -hex 16)
+cat <<EOF >/opt/plane/apps/api/.env
+DEBUG=0
+CORS_ALLOWED_ORIGINS=http://${LOCAL_IP}
+
+POSTGRES_USER=plane
+POSTGRES_PASSWORD=${PG_DB_PASS}
+POSTGRES_HOST=localhost
+POSTGRES_DB=plane
+POSTGRES_PORT=5432
+DATABASE_URL=postgresql://plane:${PG_DB_PASS}@localhost:5432/plane
+
+REDIS_HOST=localhost
+REDIS_PORT=6379
+REDIS_URL=redis://localhost:6379/
+
+RABBITMQ_HOST=localhost
+RABBITMQ_PORT=5672
+RABBITMQ_USER=plane
+RABBITMQ_PASSWORD=${RABBITMQ_PASS}
+RABBITMQ_VHOST=plane
+AMQP_URL=amqp://plane:${RABBITMQ_PASS}@localhost:5672/plane
+
+AWS_REGION=us-east-1
+AWS_ACCESS_KEY_ID=${MINIO_ACCESS_KEY}
+AWS_SECRET_ACCESS_KEY=${MINIO_SECRET_KEY}
+AWS_S3_ENDPOINT_URL=http://localhost:9000
+AWS_S3_BUCKET_NAME=uploads
+FILE_SIZE_LIMIT=5242880
+
+USE_MINIO=1
+MINIO_ENDPOINT_SSL=0
+SECRET_KEY=${SECRET_KEY}
+MACHINE_SIGNATURE=${MACHINE_SIG}
+
+WEB_URL=http://${LOCAL_IP}
+ADMIN_BASE_URL=http://${LOCAL_IP}
+ADMIN_BASE_PATH=/god-mode
+SPACE_BASE_URL=http://${LOCAL_IP}
+SPACE_BASE_PATH=/spaces
+APP_BASE_URL=http://${LOCAL_IP}
+APP_BASE_PATH=
+LIVE_BASE_URL=http://${LOCAL_IP}
+LIVE_BASE_PATH=/live
+
+GUNICORN_WORKERS=2
+LIVE_SERVER_SECRET_KEY=${LIVE_SECRET}
+API_KEY_RATE_LIMIT=60/minute
+EOF
+cat <<EOF>/opt/plane/.env
+API_BASE_URL=http://localhost:8000
+LIVE_SERVER_SECRET_KEY=${LIVE_SECRET}
+REDIS_HOST=localhost
+REDIS_PORT=6379
+REDIS_URL=redis://localhost:6379/
+PORT=3100
+EOF
+msg_ok "Configured Plane"
+
+msg_info "Running Database Migrations"
+cd /opt/plane/apps/api
+set -a
+source /opt/plane/apps/api/.env
+set +a
+$STD /opt/plane-venv/bin/python manage.py migrate
+$STD /opt/plane-venv/bin/python manage.py collectstatic --noinput
+$STD /opt/plane-venv/bin/python manage.py configure_instance
+$STD /opt/plane-venv/bin/python manage.py register_instance "${MACHINE_SIG}"
+msg_ok "Ran Database Migrations"
+
+msg_info "Creating Services and MinIO Bucket"
+curl -fsSL https://dl.min.io/client/mc/release/linux-amd64/mc -o /usr/local/bin/mcli
+chmod +x /usr/local/bin/mcli
+$STD /usr/local/bin/mcli alias set plane http://localhost:9000 "${MINIO_ACCESS_KEY}" "${MINIO_SECRET_KEY}"
+$STD /usr/local/bin/mcli mb plane/uploads --ignore-existing
+
+cat <<EOF >/etc/systemd/system/plane-api.service
+[Unit]
+Description=Plane API
+After=network.target postgresql.service redis-server.service rabbitmq-server.service minio.service
+
+[Service]
+Type=simple
+WorkingDirectory=/opt/plane/apps/api
+EnvironmentFile=/opt/plane/apps/api/.env
+ExecStart=/opt/plane-venv/bin/gunicorn -w 2 -k uvicorn.workers.UvicornWorker plane.asgi:application --bind 0.0.0.0:8000 --max-requests 1200 --max-requests-jitter 1000 --access-logfile -
+Restart=on-failure
+RestartSec=5
+
+[Install]
+WantedBy=multi-user.target
+EOF
+
+cat <<EOF >/etc/systemd/system/plane-worker.service
+[Unit]
+Description=Plane Celery Worker
+After=plane-api.service
+Requires=plane-api.service
+
+[Service]
+Type=simple
+WorkingDirectory=/opt/plane/apps/api
+EnvironmentFile=/opt/plane/apps/api/.env
+ExecStart=/opt/plane-venv/bin/celery -A plane worker -l info
+Restart=on-failure
+RestartSec=5
+
+[Install]
+WantedBy=multi-user.target
+EOF
+
+cat <<EOF >/etc/systemd/system/plane-beat.service
+[Unit]
+Description=Plane Celery Beat
+After=plane-api.service
+Requires=plane-api.service
+
+[Service]
+Type=simple
+WorkingDirectory=/opt/plane/apps/api
+EnvironmentFile=/opt/plane/apps/api/.env
+ExecStart=/opt/plane-venv/bin/celery -A plane beat -l info
+Restart=on-failure
+RestartSec=5
+
+[Install]
+WantedBy=multi-user.target
+EOF
+
+cat <<EOF >/etc/systemd/system/plane-live.service
+[Unit]
+Description=Plane Live Server
+After=network.target
+
+[Service]
+Type=simple
+WorkingDirectory=/opt/plane
+EnvironmentFile=/opt/plane/.env
+ExecStart=/usr/bin/node apps/live/dist/start.mjs
+Restart=on-failure
+RestartSec=5
+
+[Install]
+WantedBy=multi-user.target
+EOF
+
+cat <<EOF >/etc/systemd/system/plane-space.service
+[Unit]
+Description=Plane Space Server
+After=network.target
+
+[Service]
+Type=simple
+WorkingDirectory=/opt/plane/apps/space
+Environment=PORT=3002
+Environment=NODE_ENV=production
+ExecStart=/opt/plane/apps/space/node_modules/.bin/react-router-serve ./build/server/index.js
+Restart=on-failure
+RestartSec=5
+
+[Install]
+WantedBy=multi-user.target
+EOF
+systemctl daemon-reload
+systemctl enable -q --now plane-api plane-worker plane-beat plane-live plane-space
+{
+    echo "RabbitMQ User: plane"
+    echo "RabbitMQ Password: ${RABBITMQ_PASS}"
+    echo "MinIO Access Key: ${MINIO_ACCESS_KEY}"
+    echo "MinIO Secret Key: ${MINIO_SECRET_KEY}"
+    echo "Secret Key: ${SECRET_KEY}"
+    echo "Config: /opt/plane/apps/api/.env"
+} >>~/plane.creds
+msg_ok "Created Services and MinIO Bucket"
+
+msg_info "Configuring Nginx"
+cat <<'EOF' >/etc/nginx/sites-available/plane.conf
+upstream plane-api {
+    server 127.0.0.1:8000;
+}
+
+upstream plane-live {
+    server 127.0.0.1:3100;
+}
+
+upstream plane-space {
+    server 127.0.0.1:3002;
+}
+
+upstream plane-minio {
+    server 127.0.0.1:9000;
+}
+
+server {
+    listen 80 default_server;
+    server_name _;
+    client_max_body_size 5M;
+
+    location /api/ {
+        proxy_pass http://plane-api;
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
+    }
+
+    location /auth/ {
+        proxy_pass http://plane-api;
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
+    }
+
+    location /static/ {
+        alias /opt/plane/apps/api/plane/static-assets/collected-static/;
+    }
+
+    location /live/ {
+        proxy_pass http://plane-live;
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection "upgrade";
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
+    }
+
+    location /uploads/ {
+        proxy_pass http://plane-minio;
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    }
+
+    location /spaces/ {
+        proxy_pass http://plane-space;
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
+    }
+
+    location /spaces {
+        return 301 /spaces/;
+    }
+
+    location /god-mode/ {
+        alias /opt/plane/apps/admin/build/client/;
+        try_files $uri $uri/ /god-mode/index.html;
+    }
+
+    location /god-mode {
+        return 301 /god-mode/;
+    }
+
+    location / {
+        root /opt/plane/apps/web/build/client;
+        try_files $uri $uri/ /index.html;
+    }
+}
+EOF
+ln -sf /etc/nginx/sites-available/plane.conf /etc/nginx/sites-enabled/plane.conf
+rm -f /etc/nginx/sites-enabled/default
+$STD systemctl reload nginx
+msg_ok "Configured Nginx"
+
+motd_ssh
+customize
+cleanup_lxc