From b1ee761b44f7908e04db45fecd20322d39f9b3cc Mon Sep 17 00:00:00 2001 From: MickLesk Date: Sun, 22 Feb 2026 14:12:34 +0100 Subject: [PATCH] feat: add Twenty CRM script (#1476) - Add ct/twenty.sh with update function - Add install/twenty-install.sh (Node.js 24, PostgreSQL 16, Redis) - Add frontend/public/json/twenty.json metadata - Builds from source: yarn + nx monorepo (server + frontend) - Server on port 3000, worker as separate systemd service --- ct/twenty.sh | 87 +++++++++++++++++++++++++ frontend/public/json/twenty.json | 48 ++++++++++++++ install/twenty-install.sh | 107 +++++++++++++++++++++++++++++++ 3 files changed, 242 insertions(+) create mode 100644 ct/twenty.sh create mode 100644 frontend/public/json/twenty.json create mode 100644 install/twenty-install.sh diff --git a/ct/twenty.sh b/ct/twenty.sh new file mode 100644 index 000000000..f21834ce8 --- /dev/null +++ b/ct/twenty.sh @@ -0,0 +1,87 @@ +#!/usr/bin/env bash +source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVED/main/misc/build.func) +# Copyright (c) 2021-2026 community-scripts ORG +# Author: MickLesk (CanbiZ) +# License: MIT | https://github.com/community-scripts/ProxmoxVED/raw/main/LICENSE +# Source: https://github.com/twentyhq/twenty + +APP="Twenty" +var_tags="${var_tags:-crm;business;contacts}" +var_cpu="${var_cpu:-4}" +var_ram="${var_ram:-8192}" +var_disk="${var_disk:-20}" +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/twenty ]]; then + msg_error "No ${APP} Installation Found!" + exit + fi + + if check_for_gh_release "twenty" "twentyhq/twenty"; then + msg_info "Stopping Services" + systemctl stop twenty-worker twenty-server + msg_ok "Stopped Services" + + msg_info "Backing up Data" + cp /opt/twenty/.env /opt/twenty.env.bak + cp -r /opt/twenty/packages/twenty-server/.local-storage /opt/twenty_storage_backup 2>/dev/null || true + msg_ok "Backed up Data" + + CLEAN_INSTALL=1 fetch_and_deploy_gh_release "twenty" "twentyhq/twenty" "tarball" + + msg_info "Restoring Configuration" + cp /opt/twenty.env.bak /opt/twenty/.env + msg_ok "Restored Configuration" + + msg_info "Building Application" + cd /opt/twenty + export COREPACK_ENABLE_DOWNLOAD_PROMPT=0 + $STD corepack enable + $STD corepack prepare yarn@4.9.2 --activate + export NODE_OPTIONS="--max-old-space-size=4096" + $STD yarn install --immutable || $STD yarn install + $STD npx nx run twenty-server:build + $STD npx nx build twenty-front + cp -r /opt/twenty/packages/twenty-front/build /opt/twenty/packages/twenty-server/dist/front + msg_ok "Built Application" + + msg_info "Running Database Migrations" + cd /opt/twenty/packages/twenty-server + set -a && source /opt/twenty/.env && set +a + $STD npx ts-node ./scripts/setup-db.ts + $STD npx -y typeorm migration:run -d dist/database/typeorm/core/core.datasource + msg_ok "Ran Database Migrations" + + msg_info "Restoring Storage" + cp -r /opt/twenty_storage_backup/. /opt/twenty/packages/twenty-server/.local-storage/ 2>/dev/null || true + rm -rf /opt/twenty_storage_backup /opt/twenty.env.bak + msg_ok "Restored Storage" + + msg_info "Starting Services" + systemctl start twenty-server twenty-worker + 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}:3000${CL}" diff --git a/frontend/public/json/twenty.json b/frontend/public/json/twenty.json new file mode 100644 index 000000000..ad3fbb9a8 --- /dev/null +++ b/frontend/public/json/twenty.json @@ -0,0 +1,48 @@ +{ + "name": "Twenty", + "slug": "twenty", + "categories": [ + 25 + ], + "date_created": "2026-02-22", + "type": "ct", + "updateable": true, + "privileged": false, + "interface_port": 3000, + "documentation": "https://docs.twenty.com/", + "website": "https://twenty.com/", + "logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/twenty.webp", + "config_path": "/opt/twenty/.env", + "description": "Twenty is a modern open-source CRM platform that helps you manage customer relationships, track deals, and organize contacts with a clean and powerful interface.", + "install_methods": [ + { + "type": "default", + "script": "ct/twenty.sh", + "resources": { + "cpu": 4, + "ram": 8192, + "hdd": 20, + "os": "Debian", + "version": "13" + } + } + ], + "default_credentials": { + "username": null, + "password": null + }, + "notes": [ + { + "text": "First visit will prompt you to create a workspace and admin account.", + "type": "info" + }, + { + "text": "Building from source requires significant resources and takes 10-15 minutes.", + "type": "warning" + }, + { + "text": "Update SERVER_URL in /opt/twenty/.env if accessing from a different hostname.", + "type": "info" + } + ] +} diff --git a/install/twenty-install.sh b/install/twenty-install.sh new file mode 100644 index 000000000..dbe51c724 --- /dev/null +++ b/install/twenty-install.sh @@ -0,0 +1,107 @@ +#!/usr/bin/env bash + +# Copyright (c) 2021-2026 community-scripts ORG +# Author: MickLesk (CanbiZ) +# License: MIT | https://github.com/community-scripts/ProxmoxVED/raw/main/LICENSE +# Source: https://github.com/twentyhq/twenty + +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 \ + build-essential \ + redis-server +msg_ok "Installed Dependencies" + +PG_VERSION="16" setup_postgresql +PG_DB_NAME="default" PG_DB_USER="twenty" setup_postgresql_db +NODE_VERSION="24" setup_nodejs + +fetch_and_deploy_gh_release "twenty" "twentyhq/twenty" "tarball" + +msg_info "Building Application" +cd /opt/twenty +export COREPACK_ENABLE_DOWNLOAD_PROMPT=0 +$STD corepack enable +$STD corepack prepare yarn@4.9.2 --activate +export NODE_OPTIONS="--max-old-space-size=4096" +$STD yarn install --immutable || $STD yarn install +$STD npx nx run twenty-server:build +$STD npx nx build twenty-front +cp -r /opt/twenty/packages/twenty-front/build /opt/twenty/packages/twenty-server/dist/front +msg_ok "Built Application" + +msg_info "Configuring Application" +APP_SECRET=$(openssl rand -base64 32) +mkdir -p /opt/twenty/packages/twenty-server/.local-storage +cat </opt/twenty/.env +NODE_PORT=3000 +PG_DATABASE_URL=postgresql://${PG_DB_USER}:${PG_DB_PASS}@localhost:5432/${PG_DB_NAME} +REDIS_URL=redis://localhost:6379 +SERVER_URL=http://${LOCAL_IP}:3000 +APP_SECRET=${APP_SECRET} +STORAGE_TYPE=local +NODE_ENV=production +EOF +msg_ok "Configured Application" + +msg_info "Running Database Migrations" +cd /opt/twenty/packages/twenty-server +set -a && source /opt/twenty/.env && set +a +$STD npx ts-node ./scripts/setup-db.ts +$STD npx -y typeorm migration:run -d dist/database/typeorm/core/core.datasource +msg_ok "Ran Database Migrations" + +msg_info "Creating Services" +cat </etc/systemd/system/twenty-server.service +[Unit] +Description=Twenty CRM Server +After=network.target postgresql.service redis-server.service +Requires=postgresql.service redis-server.service + +[Service] +Type=simple +User=root +WorkingDirectory=/opt/twenty/packages/twenty-server +EnvironmentFile=/opt/twenty/.env +ExecStart=/usr/bin/node dist/main +Restart=on-failure +RestartSec=5 + +[Install] +WantedBy=multi-user.target +EOF + +cat </etc/systemd/system/twenty-worker.service +[Unit] +Description=Twenty CRM Worker +After=network.target postgresql.service redis-server.service twenty-server.service +Requires=postgresql.service redis-server.service + +[Service] +Type=simple +User=root +WorkingDirectory=/opt/twenty/packages/twenty-server +EnvironmentFile=/opt/twenty/.env +Environment=DISABLE_DB_MIGRATIONS=true +Environment=DISABLE_CRON_JOBS_REGISTRATION=true +ExecStart=/usr/bin/node dist/queue-worker/queue-worker +Restart=on-failure +RestartSec=5 + +[Install] +WantedBy=multi-user.target +EOF + +systemctl enable -q --now redis-server twenty-server twenty-worker +msg_ok "Created Services" + +motd_ssh +customize +cleanup_lxc