Compare commits

..

1 Commits

Author SHA1 Message Date
push-app-to-main[bot] 67ab393789 Add plane (ct) 2026-06-19 21:33:59 +00:00
4 changed files with 484 additions and 45 deletions
+6
View File
@@ -0,0 +1,6 @@
____ __
/ __ \/ /___ _____ ___
/ /_/ / / __ `/ __ \/ _ \
/ ____/ / /_/ / / / / __/
/_/ /_/\__,_/_/ /_/\___/
+88
View File
@@ -0,0 +1,88 @@
#!/usr/bin/env bash
source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/build.func)
# Copyright (c) 2021-2026 community-scripts ORG
# Author: onionrings29
# License: MIT | https://github.com/community-scripts/ProxmoxVE/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:-4}"
var_ram="${var_ram:-6144}"
var_disk="${var_disk:-8}"
var_os="${var_os:-debian}"
var_version="${var_version:-13}"
var_arm64="${var_arm64:-no}"
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"
create_backup /opt/plane/.env \
/opt/plane/apps/admin/.env \
/opt/plane/apps/api/.env \
/opt/plane/apps/space/.env \
/opt/plane/apps/web/.env
CLEAN_INSTALL=1 fetch_and_deploy_gh_release "plane" "makeplane/plane" "tarball"
restore_backup
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}"
+386
View File
@@ -0,0 +1,386 @@
#!/usr/bin/env bash
# Copyright (c) 2021-2026 community-scripts ORG
# Author: onionrings29
# License: MIT | https://github.com/community-scripts/ProxmoxVE/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="24" 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=104857600
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
$STD /usr/local/bin/mcli anonymous set download plane/uploads
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 100M;
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 /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
+4 -45
View File
@@ -519,19 +519,6 @@ validate_bridge() {
return 0
}
# ------------------------------------------------------------------------------
# validate_sdn_vnet()
#
# - Validates that an SDN vnet exists in the cluster config
# ------------------------------------------------------------------------------
validate_sdn_vnet() {
local vnet="$1"
[[ -z "$vnet" ]] && return 1
[[ -f /etc/pve/sdn/vnets.cfg ]] && grep -qE "^vnet:[[:space:]]*${vnet}([[:space:]]|$)" /etc/pve/sdn/vnets.cfg && return 0
command -v pvesh &>/dev/null && pvesh get "/cluster/sdn/vnets/${vnet}" &>/dev/null && return 0
return 1
}
# ------------------------------------------------------------------------------
# validate_gateway_in_subnet()
#
@@ -977,7 +964,6 @@ base_settings() {
HN="$requested_hostname"
BRG=${var_brg:-"vmbr0"}
SDN_VNET=${var_sdn_vnet:-""}
NET=${var_net:-"dhcp"}
# Resolve IP range if NET contains a range (e.g., 192.168.1.100/24-192.168.1.200/24)
@@ -1089,7 +1075,7 @@ load_vars_file() {
var_gateway var_hostname var_ipv6_method var_mac var_mknod var_mount_fs var_mtu
var_net var_nesting var_ns var_os var_protection var_pw var_ram var_tags var_timezone var_tun var_unprivileged
var_verbose var_version var_vlan var_ssh var_ssh_authorized_key var_container_storage var_template_storage var_searchdomain
var_post_install var_sdn_vnet
var_post_install
)
# Whitelist check helper
@@ -1264,12 +1250,6 @@ load_vars_file() {
continue
fi
;;
var_sdn_vnet)
if [[ -n "$var_val" ]] && ! validate_sdn_vnet "$var_val"; then
msg_warn "SDN vnet '$var_val' from $file not found, ignoring"
continue
fi
;;
var_container_storage | var_template_storage)
# Validate that the storage exists and is active on the current node
local _storage_status
@@ -1313,7 +1293,7 @@ default_var_settings() {
var_gateway var_hostname var_ipv6_method var_mac var_mknod var_mount_fs var_mtu
var_net var_nesting var_ns var_os var_protection var_pw var_ram var_tags var_timezone var_tun var_unprivileged
var_verbose var_version var_vlan var_ssh var_ssh_authorized_key var_container_storage var_template_storage
var_post_install var_sdn_vnet
var_post_install
)
# Snapshot: environment variables (highest precedence)
@@ -1492,7 +1472,7 @@ if ! declare -p VAR_WHITELIST >/dev/null 2>&1; then
var_gateway var_hostname var_ipv6_method var_mac var_mknod var_mount_fs var_mtu
var_net var_nesting var_ns var_os var_protection var_pw var_ram var_tags var_timezone var_tun var_unprivileged
var_verbose var_version var_vlan var_ssh var_ssh_authorized_key var_container_storage var_template_storage var_searchdomain
var_post_install var_sdn_vnet
var_post_install
)
fi
@@ -1702,7 +1682,6 @@ _build_current_app_vars_tmp() {
[ -n "$_hostname" ] && echo "var_hostname=$(_sanitize_value "$_hostname")"
[ -n "$_searchdomain" ] && echo "var_searchdomain=$(_sanitize_value "$_searchdomain")"
[ -n "${var_sdn_vnet:-}" ] && echo "var_sdn_vnet=$(_sanitize_value "${var_sdn_vnet}")"
[ -n "$_tpl_storage" ] && echo "var_template_storage=$(_sanitize_value "$_tpl_storage")"
[ -n "$_ct_storage" ] && echo "var_container_storage=$(_sanitize_value "$_ct_storage")"
@@ -1863,7 +1842,6 @@ advanced_settings() {
local _core_count="${var_cpu:-1}"
local _ram_size="${var_ram:-1024}"
local _bridge="${var_brg:-vmbr0}"
local _sdn_vnet="${var_sdn_vnet:-}"
local _net="${var_net:-dhcp}"
local _gate="${var_gateway:-}"
local _ipv6_method="${var_ipv6_method:-auto}"
@@ -1943,11 +1921,6 @@ advanced_settings() {
fi
done <<<"$BRIDGES"
fi
if [[ -f /etc/pve/sdn/vnets.cfg ]]; then
while IFS= read -r vnet; do
[[ -n "$vnet" ]] && BRIDGE_MENU_OPTIONS+=("sdn:${vnet}" "[SDN] ${vnet}")
done < <(awk '/^vnet:/{print $2}' /etc/pve/sdn/vnets.cfg 2>/dev/null)
fi
}
_detect_bridges
@@ -2180,18 +2153,8 @@ advanced_settings() {
if [[ "$bridge_test" == "__other__" || "$bridge_test" == -* ]]; then
continue
fi
if [[ "$bridge_test" == sdn:* ]]; then
local vnet_test="${bridge_test#sdn:}"
if validate_sdn_vnet "$vnet_test"; then
_sdn_vnet="$vnet_test"
_bridge="${var_brg:-vmbr0}"
((STEP++))
else
whiptail --msgbox "SDN vnet '$vnet_test' is not configured on this cluster." 8 58
fi
elif validate_bridge "$bridge_test"; then
if validate_bridge "$bridge_test"; then
_bridge="$bridge_test"
_sdn_vnet=""
((STEP++))
else
whiptail --msgbox "Bridge '$bridge_test' is not available or not active." 8 58
@@ -2928,7 +2891,6 @@ Advanced:
var_timezone="$_ct_timezone"
var_apt_cacher="$_apt_cacher"
var_apt_cacher_ip="$_apt_cacher_ip"
var_sdn_vnet="$_sdn_vnet"
# Format optional values
[[ -n "$_mtu" ]] && MTU=",mtu=$_mtu" || MTU=""
@@ -3820,9 +3782,6 @@ build_container() {
# if [ "$VERBOSE" == "yes" ]; then set -x; fi
NET_STRING="-net0 name=eth0,bridge=${BRG:-vmbr0}"
if [[ -n "${var_sdn_vnet:-${SDN_VNET:-}}" ]]; then
NET_STRING="-net0 name=eth0,vnet=${var_sdn_vnet:-$SDN_VNET}"
fi
# MAC
if [[ -n "$MAC" ]]; then