Skip to content

docs: Add silent installation guide for enterprise deployments - #3178

Merged
jeanfbrito merged 1 commit into
masterfrom
silent-installing
Jul 10, 2026
Merged

docs: Add silent installation guide for enterprise deployments#3178
jeanfbrito merged 1 commit into
masterfrom
silent-installing

Conversation

@jeanfbrito

@jeanfbrito jeanfbrito commented Jan 16, 2026

Copy link
Copy Markdown
Member

Add comprehensive documentation covering:

  • Silent install commands for Windows (NSIS, MSI), macOS (PKG, DMG), and Linux (DEB, RPM, AppImage, Snap, Flatpak)
  • System and network requirements
  • Post-installation configuration (servers.json, overridden-settings.json)
  • Enterprise deployment scenarios (Group Policy, SCCM/Intune, MDM, Ansible)
  • Installation verification commands
  • Troubleshooting guide and exit codes
  • Automation best practices with error handling examples

Closes #ISSUE_NUMBER

Summary by CodeRabbit

  • Documentation
    • Added comprehensive Silent Installation Guide covering Windows, macOS, and Linux platforms, including installation commands, configuration options, enterprise deployment scenarios, and troubleshooting guidance.

✏️ Tip: You can customize this high-level summary in your review settings.

Add comprehensive documentation covering:
- Silent install commands for Windows (NSIS, MSI), macOS (PKG, DMG), and Linux (DEB, RPM, AppImage, Snap, Flatpak)
- System and network requirements
- Post-installation configuration (servers.json, overridden-settings.json)
- Enterprise deployment scenarios (Group Policy, SCCM/Intune, MDM, Ansible)
- Installation verification commands
- Troubleshooting guide and exit codes
- Automation best practices with error handling examples
@coderabbitai

coderabbitai Bot commented Jan 16, 2026

Copy link
Copy Markdown
Contributor

Walkthrough

A comprehensive Silent Installation Guide document is added, detailing unattended deployment procedures for Rocket.Chat Desktop across Windows, macOS, and Linux platforms, including installer-specific commands, configuration options, enterprise deployment scenarios, and troubleshooting guidance.

Changes

Cohort / File(s) Summary
Silent Installation Documentation
docs/silent-installation.md
Adds comprehensive guide (+924 lines) covering unattended installation procedures across multiple platforms and installers (NSIS, MSI, PKG, DMG, DEB, RPM, AppImage, Snap, Flatpak), including system/network requirements, installer flags and commands, post-install configuration (servers.json, overridden-settings.json), enterprise deployment scenarios (Group Policy, SCCM/Intune, MDM, Ansible, Docker), verification steps, troubleshooting, exit codes, and automation best practices

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 Silent deployments hop into view,
A guide so thorough, documentation new!
From Windows to Linux, each platform set right,
Unattended installs now work day and night! ✨
This rabbit cheers loud—installation's a breeze! 🚀

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: Add silent installation guide for enterprise deployments' directly and clearly summarizes the main change—adding comprehensive documentation for silent installation targeting enterprise use cases.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch silent-installing

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@docs/silent-installation.md`:
- Line 578: Change the heading text "#### Examples" to "### Examples" so the
markdown heading hierarchy is correct (it currently jumps from an h2 to h4);
locate the heading string "#### Examples" in the document and update it to "###
Examples" to restore proper h2→h3→h4 structure.
🧹 Nitpick comments (1)
docs/silent-installation.md (1)

657-684: Consider parameterizing version numbers in deployment examples.

The Ansible playbook hardcodes version "4.11.1" in URLs. While this makes the example concrete and copy-pasteable, consider adding a variable at the top for easier maintenance.

♻️ Optional parameterization approach
 - name: Install Rocket.Chat Desktop
   hosts: workstations
   become: yes
+  vars:
+    rocketchat_version: "4.11.1"
   tasks:
     - name: Install Rocket.Chat (Debian/Ubuntu)
       apt:
-        deb: 'https://github.com/RocketChat/Rocket.Chat.Electron/releases/download/4.11.1/rocketchat-4.11.1-linux-amd64.deb'
+        deb: 'https://github.com/RocketChat/Rocket.Chat.Electron/releases/download/{{ rocketchat_version }}/rocketchat-{{ rocketchat_version }}-linux-amd64.deb'
       when: ansible_os_family == "Debian"

     - name: Install Rocket.Chat (RHEL/Fedora)
       dnf:
-        name: 'https://github.com/RocketChat/Rocket.Chat.Electron/releases/download/4.11.1/rocketchat-4.11.1-linux-x86_64.rpm'
+        name: 'https://github.com/RocketChat/Rocket.Chat.Electron/releases/download/{{ rocketchat_version }}/rocketchat-{{ rocketchat_version }}-linux-x86_64.rpm'
         state: present
         disable_gpg_check: yes
       when: ansible_os_family == "RedHat"

| `--ozone-platform=x11` | Force X11 display server (Linux) |
| `--ozone-platform=wayland` | Force Wayland display server (Linux) |

#### Examples

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix heading level hierarchy.

The heading jumps from h2 (line 566) to h4 without an h3, violating markdown heading hierarchy. Change #### Examples to ### Examples.

📝 Proposed fix
-#### Examples
+### Examples
📝 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
#### Examples
### Examples
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

578-578: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4

(MD001, heading-increment)

🤖 Prompt for AI Agents
In `@docs/silent-installation.md` at line 578, Change the heading text "####
Examples" to "### Examples" so the markdown heading hierarchy is correct (it
currently jumps from an h2 to h4); locate the heading string "#### Examples" in
the document and update it to "### Examples" to restore proper h2→h3→h4
structure.

@jeanfbrito
jeanfbrito merged commit e74ab38 into master Jul 10, 2026
9 checks passed
@jeanfbrito
jeanfbrito deleted the silent-installing branch July 10, 2026 12:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant