Skip to content

Update HW_INSTALL.md#1222

Merged
jokob-sk merged 1 commit intonetalertx:mainfrom
JVKeller:patch-1
Oct 6, 2025
Merged

Update HW_INSTALL.md#1222
jokob-sk merged 1 commit intonetalertx:mainfrom
JVKeller:patch-1

Conversation

@JVKeller
Copy link
Contributor

@JVKeller JVKeller commented Oct 6, 2025

Adding new script.

Summary by CodeRabbit

  • Documentation
    • Added a “Bare Metal - Proxmox” deployment section with step-by-step guidance.
    • Included recommendations to use a clean LXC/VM on Debian 13 or Ubuntu 24.
    • Provided a wget-based installation command for streamlined setup.
    • Positioned the new section after the Ubuntu 24 installation instructions.
    • No application behavior changes; this update is documentation-only.

Adding new script.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 6, 2025

Walkthrough

Adds a “Bare Metal - Proxmox” section to HW installation docs, recommending a clean LXC/VM (Debian 13 or Ubuntu 24) and providing a wget-based install command for proxmox-install-netalertx.sh. Appended after Ubuntu 24 section. Contains minor typos; no code or behavior changes.

Changes

Cohort / File(s) Summary of Changes
Docs: Proxmox install section
docs/HW_INSTALL.md
Appended a new “Bare Metal - Proxmox” subsection with prerequisites and a wget-based installer command for proxmox-install-netalertx.sh; minor typos noted; no code changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Poem

I thump my paw on Proxmox ground,
A wget whisper, a tidy sound—
Fresh LXC, Debian’s shine,
Ubuntu 24, all aligned.
Docs now point the burrow’s way,
Hop, install, and scan the day. 🐇✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title Check ❓ Inconclusive The title “Update HW_INSTALL.md” is generic and does not specify the key change of adding a new “Bare Metal – Proxmox” section to the deployment documentation, so it fails to clearly summarize the primary content update. Please revise the title to reflect the main change, for example “Add Bare Metal – Proxmox deployment instructions to HW_INSTALL.md,” so reviewers can immediately understand the new content.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4170812 and b5062f6.

📒 Files selected for processing (1)
  • docs/HW_INSTALL.md (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

Comment on lines +79 to +82
> [!NOTE]
> Use this on a clean LXC/VM for Debian 13 OR Ubuntu 24.
> The Scipt will detect OS and build acordingly.

Copy link
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 typos in the Proxmox note.

Please correct “Scipt” → “script” and “acordingly” → “accordingly” to keep the docs polished.

🤖 Prompt for AI Agents
In docs/HW_INSTALL.md around lines 79 to 82, fix the typos in the Proxmox note:
change “Scipt” to “script” and “acordingly” to “accordingly” so the sentence
reads correctly (e.g., “The script will detect OS and build accordingly.”).

@jokob-sk jokob-sk merged commit 33093db into netalertx:main Oct 6, 2025
4 checks passed
@adamoutler
Copy link
Member

FYI the base docker image is going through some changes. if you're depending on resources being somewhere, I'd recommend placing them in the install/proxmox folder.

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.

3 participants