Installer rework #1174
Merged
Installer rework #1174
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TMPFS runs out of memory, so removing size limits. Fixing some order of execution
…tAlertX into installer-rework
Contributor
WalkthroughThe Ubuntu 24 startup script’s log/api tmpfs setup was reworked: it now prints banners, unmounts existing mounts, ensures directories and multiple log files exist, mounts tmpfs without explicit sizes using noexec/nosuid/nodev, creates additional log assets, and sets specific ownership for api/user_notifications.json, with updated sequencing and echoes. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant U as Operator
participant S as start.ubuntu24.sh
participant OS as OS Mount Utils
participant FS as Filesystem
U->>S: Run script
S->>S: Print banners / progress
S->>OS: Unmount ${INSTALL_DIR}/log
OS-->>S: Unmounted or not mounted
S->>OS: Unmount ${INSTALL_DIR}/api
OS-->>S: Unmounted or not mounted
S->>FS: Ensure dirs: log/, log/plugins/, api/
FS-->>S: Dirs present
S->>OS: Mount tmpfs on log (noexec,nosuid,nodev)
OS-->>S: Mounted
S->>OS: Mount tmpfs on api (noexec,nosuid,nodev)
OS-->>S: Mounted
S->>FS: Create log files (app.log, stderr.log, …)
FS-->>S: Files created
S->>FS: Create api/user_notifications.json
FS-->>S: File created
S->>FS: chown root:www-data user_notifications.json
FS-->>S: Ownership set
S-->>U: Done (echo status)
note over S,OS: Changed flow: explicit unmounts, size-less tmpfs, added file setup and chown
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
install/ubuntu24/start.ubuntu24.sh (2)
146-149: Guard umounts to avoid noisy failures and handle busy mounts.If the mount points aren’t mounted (fresh install) or are busy, plain umount will error and spam logs. Prefer checking with mountpoint and falling back to a lazy unmount.
-umount "${INSTALL_DIR}/log" -umount "${INSTALL_DIR}/api" +for m in "${INSTALL_DIR}/log" "${INSTALL_DIR}/api"; do + if mountpoint -q "$m"; then + umount "$m" || { echo "[INSTALL] Warning: failed to unmount $m (may be busy)"; umount -l "$m" || true; } + fi +done
158-169: Ensure writable permissions for www-data without overexposing.You chown api/user_notifications.json to root:www-data but don’t grant group write. If the web app writes to it, set mode 660. Also set group and setgid on log dirs so new files inherit www-data group, avoiding later broad a+rwx.
-touch "${INSTALL_DIR}"/log/{app.log,execution_queue.log,app_front.log,app.php_errors.log,stderr.log,stdout.log,db_is_locked.log} -touch "${INSTALL_DIR}"/api/user_notifications.json +touch "${INSTALL_DIR}"/log/{app.log,execution_queue.log,app_front.log,app.php_errors.log,stderr.log,stdout.log,db_is_locked.log} +chgrp www-data "${INSTALL_DIR}"/log/{app.log,execution_queue.log,app_front.log,app.php_errors.log,stderr.log,stdout.log,db_is_locked.log} +chmod 664 "${INSTALL_DIR}"/log/{app.log,execution_queue.log,app_front.log,app.php_errors.log,stderr.log,stdout.log,db_is_locked.log} +install -o root -g www-data -m 660 /dev/null "${INSTALL_DIR}/api/user_notifications.json" # Create plugins sub-directory if it doesn't exist in case a custom log folder is used mkdir -p "${INSTALL_DIR}"/log/plugins + +# Keep www-data group for new files in log dirs +chgrp -R www-data "${INSTALL_DIR}/log" +chmod 2775 "${INSTALL_DIR}/log" "${INSTALL_DIR}/log/plugins"
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
install/ubuntu24/start.ubuntu24.sh(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: docker_dev
🔇 Additional comments (1)
install/ubuntu24/start.ubuntu24.sh (1)
141-145: Banners/readability: LGTM.The added banners make the installer flow clearer.
Comment on lines
+153
to
+156
| echo "[INSTALL] Mounting log and api folders as tmpfs" | ||
| mount -t tmpfs -o noexec,nosuid,nodev tmpfs "${INSTALL_DIR}/log" | ||
| mount -t tmpfs -o noexec,nosuid,nodev tmpfs "${INSTALL_DIR}/api" | ||
|
|
Contributor
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Make tmpfs sizing configurable and fail fast on mount errors.
Dropping hard limits aligns with the PR goal, but allow opt-in sizing via env to prevent host-wide OOM in constrained setups, and stop on mount failure instead of continuing.
-echo "[INSTALL] Mounting log and api folders as tmpfs"
-mount -t tmpfs -o noexec,nosuid,nodev tmpfs "${INSTALL_DIR}/log"
-mount -t tmpfs -o noexec,nosuid,nodev tmpfs "${INSTALL_DIR}/api"
+echo "[INSTALL] Mounting log and api folders as tmpfs"
+# Optional sizing via env: TMPFS_LOG_SIZE/TMPFS_API_SIZE (e.g., "128m" or "20%")
+LOG_TMPFS_OPTS=${LOG_TMPFS_OPTS:-"noexec,nosuid,nodev${TMPFS_LOG_SIZE:+,size=${TMPFS_LOG_SIZE}}"}
+API_TMPFS_OPTS=${API_TMPFS_OPTS:-"noexec,nosuid,nodev${TMPFS_API_SIZE:+,size=${TMPFS_API_SIZE}}"}
+mount -t tmpfs -o "$LOG_TMPFS_OPTS" tmpfs "${INSTALL_DIR}/log" \
+ || { echo "[INSTALL] ERROR: failed to mount ${INSTALL_DIR}/log tmpfs"; exit 1; }
+mount -t tmpfs -o "$API_TMPFS_OPTS" tmpfs "${INSTALL_DIR}/api" \
+ || { echo "[INSTALL] ERROR: failed to mount ${INSTALL_DIR}/api tmpfs"; exit 1; }Run after install to confirm mounts:
🏁 Script executed:
#!/bin/bash
mount | awk '$3 ~ /(\/app\/log|\/app\/api)/'Length of output: 43
🏁 Script executed:
#!/bin/bash
set -euo pipefail
FILE="install/ubuntu24/start.ubuntu24.sh"
echo "PWD: $(pwd)"
if [ -f "$FILE" ]; then
echo "FOUND: $FILE"
echo "---- lines 140-170 ----"
nl -ba "$FILE" | sed -n '140,170p'
echo "---- grep for tmpfs mounts in file ----"
rg -n "mount -t tmpfs" "$FILE" || true
else
echo "$FILE not found, searching repository for start.*.sh under install/"
rg -n --hidden "start.*\\.sh" install || true
echo "---- searching repo for tmpfs mounts ----"
rg -n "mount -t tmpfs" || true
fiLength of output: 130
🏁 Script executed:
#!/bin/bash
FILE="install/ubuntu24/start.ubuntu24.sh"
echo "PWD: $(pwd)"
echo "ls install/ubuntu24:"
ls -la install/ubuntu24 2>/dev/null || true
if [ -f "$FILE" ]; then
echo "FOUND: $FILE"
echo "---- lines 140-170 ----"
if command -v sed >/dev/null 2>&1; then
sed -n '140,170p' "$FILE" 2>/dev/null || true
elif command -v awk >/dev/null 2>&1; then
awk 'NR>=140 && NR<=170{print NR ":" $0}' "$FILE" || true
else
tail -n +140 "$FILE" | head -n 31 || true
fi
echo "---- grep for 'mount -t tmpfs' in file ----"
grep -n -- 'mount -t tmpfs' "$FILE" 2>/dev/null || echo "no match in file"
echo "---- grep for 'tmpfs' in file ----"
grep -n -- 'tmpfs' "$FILE" 2>/dev/null || echo "no tmpfs occurrences in file"
else
echo "$FILE not found; searching install/ for start*.sh"
if command -v rg >/dev/null 2>&1; then
rg -n --hidden "start.*\.sh" install || true
else
find install -type f -name "start*.sh" -print || true
fi
echo "---- searching repo for 'mount -t tmpfs' ----"
if command -v rg >/dev/null 2>&1; then
rg -n 'mount -t tmpfs' || true
else
grep -nR -- 'mount -t tmpfs' . || true
fi
fi
echo "---- check mount availability (sandbox) ----"
if command -v mount >/dev/null 2>&1; then
echo "mount found at: $(command -v mount)"
mount | awk '$3 ~ /(\/app\/log|\/app\/api)/' || true
else
echo "mount: not found in this sandbox; cannot verify live mounts"
fiLength of output: 2115
Make tmpfs sizing configurable and fail fast on mount errors.
File: install/ubuntu24/start.ubuntu24.sh (around lines 153–155) — add env-configurable sizes and exit if mounts fail.
-echo "[INSTALL] Mounting log and api folders as tmpfs"
-mount -t tmpfs -o noexec,nosuid,nodev tmpfs "${INSTALL_DIR}/log"
-mount -t tmpfs -o noexec,nosuid,nodev tmpfs "${INSTALL_DIR}/api"
+echo "[INSTALL] Mounting log and api folders as tmpfs"
+# Optional sizing via env: TMPFS_LOG_SIZE/TMPFS_API_SIZE (e.g., "128m" or "20%")
+LOG_TMPFS_OPTS=${LOG_TMPFS_OPTS:-"noexec,nosuid,nodev${TMPFS_LOG_SIZE:+,size=${TMPFS_LOG_SIZE}}"}
+API_TMPFS_OPTS=${API_TMPFS_OPTS:-"noexec,nosuid,nodev${TMPFS_API_SIZE:+,size=${TMPFS_API_SIZE}}"}
+mount -t tmpfs -o "$LOG_TMPFS_OPTS" tmpfs "${INSTALL_DIR}/log" \
+ || { echo "[INSTALL] ERROR: failed to mount ${INSTALL_DIR}/log tmpfs"; exit 1; }
+mount -t tmpfs -o "$API_TMPFS_OPTS" tmpfs "${INSTALL_DIR}/api" \
+ || { echo "[INSTALL] ERROR: failed to mount ${INSTALL_DIR}/api tmpfs"; exit 1; }📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| echo "[INSTALL] Mounting log and api folders as tmpfs" | |
| mount -t tmpfs -o noexec,nosuid,nodev tmpfs "${INSTALL_DIR}/log" | |
| mount -t tmpfs -o noexec,nosuid,nodev tmpfs "${INSTALL_DIR}/api" | |
| echo "[INSTALL] Mounting log and api folders as tmpfs" | |
| # Optional sizing via env: TMPFS_LOG_SIZE/TMPFS_API_SIZE (e.g., "128m" or "20%") | |
| LOG_TMPFS_OPTS=${LOG_TMPFS_OPTS:-"noexec,nosuid,nodev${TMPFS_LOG_SIZE:+,size=${TMPFS_LOG_SIZE}}"} | |
| API_TMPFS_OPTS=${API_TMPFS_OPTS:-"noexec,nosuid,nodev${TMPFS_API_SIZE:+,size=${TMPFS_API_SIZE}}"} | |
| mount -t tmpfs -o "$LOG_TMPFS_OPTS" tmpfs "${INSTALL_DIR}/log" \ | |
| || { echo "[INSTALL] ERROR: failed to mount ${INSTALL_DIR}/log tmpfs"; exit 1; } | |
| mount -t tmpfs -o "$API_TMPFS_OPTS" tmpfs "${INSTALL_DIR}/api" \ | |
| || { echo "[INSTALL] ERROR: failed to mount ${INSTALL_DIR}/api tmpfs"; exit 1; } |
This was referenced Sep 25, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
fixing out of memory issues
TMPFS runs out of memory, so removing size limits.
Fixing some order of execution
Summary by CodeRabbit
Bug Fixes
Chores