Skip to content

feat: add Rocket.Chat LXC script #2314

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MickLesk merged 8 commits into from
Oct 13, 2026
Merged

feat: add Rocket.Chat LXC script #2314

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b5d56d2
Add Rocket.Chat LXC script
william-aqn Sep 9, 2026
14e9ff5
Use fetch_and_deploy_from_url for the bundle
william-aqn Sep 9, 2026
e4eaa90
Seed the admin from env and skip the setup wizard
william-aqn Sep 9, 2026
fce3efb
Ask for the admin email via var_admin_email
william-aqn Sep 9, 2026
ec19a31
Leave var_arm64 unset rather than claiming "no"
william-aqn Sep 9, 2026
a27c3d7
Strip whitespace before validating the admin email
william-aqn Sep 9, 2026
2a67cde
Follow the new binding AGENTS.md rules
william-aqn Sep 26, 2026
67b8229
Address review: trim comments, drop the redundant || exit
william-aqn Sep 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Address review: trim comments, drop the redundant || exit 
Two points from @CrazyWolf13, both fair.

The comments were far past this repo's norm: 48 comment lines against 5 in
chatto-install.sh and 5 in stoatchat-install.sh, which is 277 lines long.
What is left is the licence header plus two one-liners, on the npm pin and
on `read || true` -- the two places where tidying the line away silently
breaks the install. The reasoning that was in those blocks belongs in the
PR description, and that is where it now lives.

`cd ... || exit` is redundant, as noted: catch_errors already installs the
handler. It was there to quiet shellcheck SC2164, which is a poor reason to
diverge from how every other script in the repo writes it.

Re-ran a clean install after the change, since dropping || exit alters what
happens on a failed cd: install completes and POST /api/v1/login with the
generated password returns status success.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
  • Loading branch information
@william-aqn @claude
william-aqn and claude committed Sep 26, 2026
commit 67b822930a27307df8dcb2ef49da1250088e9085
8 changes: 1 addition & 7 deletions ct/rocketchat.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,10 @@ var_version="${var_version:-13}"
var_arm64="${var_arm64:-yes}"
var_unprivileged="${var_unprivileged:-1}"

# lxc-attach carries the caller's environment, but only what was exported, so
# without this the install script never sees the answer and always prompts.
export var_admin_email="${var_admin_email:-}"

header_info "$APP"
variables
# variables() derives NSAPP from APP by lowercasing and stripping spaces only,
# so the dot in "Rocket.Chat" would send it looking for rocket.chat-install.sh.
NSAPP="rocketchat"
var_install="${NSAPP}-install"
color
Expand All @@ -42,8 +38,6 @@ function update_script() {
exit
fi

# Rocket.Chat ships no GitHub release assets, so check_for_gh_release cannot be
# used. releases.rocket.chat/latest/info is the authoritative stable tag.
RELEASE=$(curl -fsSL https://releases.rocket.chat/latest/info | jq -r '.tag')
if [[ "${RELEASE}" != "$(cat ~/.rocketchat 2>/dev/null)" ]]; then
msg_info "Stopping Service"
Expand All @@ -54,7 +48,7 @@ function update_script() {
echo "${RELEASE}" >~/.rocketchat

msg_info "Building Rocket.Chat ${RELEASE} (Patience)"
cd /opt/rocketchat/programs/server || exit
cd /opt/rocketchat/programs/server
$STD npm install
msg_ok "Built Rocket.Chat ${RELEASE}"

Expand Down
47 changes: 3 additions & 44 deletions install/rocketchat-install.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,57 +13,31 @@ setting_up_container
network_check
update_os

# Asked up front, before the ~250 MB download and the native-module build, so an
# interactive run is not left sitting on a prompt minutes in. An unattended run
# sets var_admin_email in the environment and is never asked.
if [[ -z "${var_admin_email:-}" ]]; then
# `|| true` is load-bearing: an unattended run reaches this over lxc-attach
# with no tty, so read hits EOF and returns 1, which the error trap would
# otherwise turn into a failed install before anything is downloaded.
# unattended runs have no tty: read returns 1 on EOF
read -r -p "${TAB3}Admin email address: " var_admin_email || true
fi
# The Proxmox web console sends a carriage return with the line and read keeps
# it, so a perfectly good address arrives as $'user@host\r' and fails the check
# below. Strip whitespace before validating; an address cannot contain any.
var_admin_email="${var_admin_email//[[:space:]]/}"
var_admin_email="${var_admin_email:-admin@example.com}"
if [[ ! "$var_admin_email" =~ ^[^@[:space:]]+@[^@[:space:]]+\.[^@[:space:]]+$ ]]; then
# Rocket.Chat silently drops an invalid ADMIN_EMAIL and leaves the admin with
# no address at all, which is harder to notice than this warning.
msg_warn "Invalid email '${var_admin_email}', falling back to admin@example.com"
var_admin_email="admin@example.com"
fi

msg_info "Installing Dependencies"
# build-essential and python3 are for node-gyp: the bundle compiles native
# modules on install and @sematext/gc-stats has no prebuilt binary to fall back
# on. graphicsmagick is the image backend named by the official Debian guide.
$STD apt install -y \
build-essential \
python3 \
graphicsmagick \
jq
msg_ok "Installed Dependencies"

# Rocket.Chat 8.x exits on MongoDB <7.0 and warns below 8.0 (support for <8.0 is
# dropped in Rocket.Chat 9). releases.rocket.chat reports 8.0 as the compatible
# series, so that is what gets installed.
MONGO_VERSION="8.0" setup_mongodb

# The server bundle validates only the Node.js MAJOR line against the version it
# was built with (bundle/.node_version.txt, currently v22.x), so the NodeSource
# 22 line satisfies it.
#
# npm is pinned to 10 because the bundle is built with npm 10 and does not
# install under npm 12: npm 12 refuses the bundle's remote tarball dependency
# (EALLOWREMOTE on source-map-support), and the bundle's own npm-rebuild.js
# calls `npm rebuild --update-binary`, a flag npm 12 rejects outright.
# npm 12 cannot install this bundle
NODE_VERSION="22" NPM_VERSION="10" setup_nodejs

msg_info "Configuring MongoDB Replica Set"
# Rocket.Chat requires a replica set: it dropped oplog tailing in 8.0 and now
# relies on change streams and multi-document transactions, neither of which a
# standalone mongod provides. A single member is enough.
if ! grep -q "^replication:" /etc/mongod.conf; then
cat <<EOF >>/etc/mongod.conf
replication:
Expand All @@ -84,31 +58,16 @@ for _ in {1..60}; do
done
msg_ok "Configured MongoDB Replica Set"

# The prebuilt Meteor bundle is published on releases.rocket.chat, not as a
# GitHub release asset, so fetch_and_deploy_gh_release does not apply.
# /latest/info names the current stable tag; the GitHub API cannot be used here
# because backport releases on older majors are published after newer ones and
# would win a "latest" query. The archive unpacks to a single bundle/ directory,
# which fetch_and_deploy_from_url strips into the target.
RELEASE=$(curl -fsSL https://releases.rocket.chat/latest/info | jq -r '.tag')
fetch_and_deploy_from_url "https://releases.rocket.chat/${RELEASE}/download" "/opt/rocketchat"
echo "${RELEASE}" >~/.rocketchat

msg_info "Building Rocket.Chat ${RELEASE} (Patience)"
cd /opt/rocketchat/programs/server || exit
cd /opt/rocketchat/programs/server
$STD npm install
msg_ok "Built Rocket.Chat ${RELEASE}"

msg_info "Creating Configuration"
# Kept outside /opt/rocketchat so an update, which replaces the bundle
# wholesale, leaves it untouched.
#
# The admin is seeded from the environment and the setup wizard is marked
# completed on purpose. The wizard's last step ("Awaiting confirmation") mails a
# confirmation code, and a fresh bare-metal install has no MAIL_URL, so the mail
# never leaves the box and the wizard cannot be finished from the UI -- the
# admin created in step 1 is then locked out behind it. insertAdminUserFromEnv()
# only fires while no admin exists, so these stay inert on every later boot.
ADMIN_PASS=$(openssl rand -base64 24 | tr -dc 'a-zA-Z0-9' | cut -c1-24)
mkdir -p /etc/rocketchat
cat <<EOF >/etc/rocketchat/rocketchat.env
Expand Down
Loading