Add alternative install instructions for ProxmoxVE #37997
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe changes introduce a new "ProxmoxVE" section to the Home Assistant Operating System installation guide. This section provides comprehensive instructions for setting up a virtual machine on Proxmox Virtual Environment. It includes steps for downloading and decompressing the HAOS image, creating a VM with specified CPU and memory, importing the disk image, and configuring hardware settings through the Proxmox WebUI. Additionally, optional guidance for adding network and USB passthrough is provided, while the existing KVM (virt-manager) instructions remain unchanged. Changes
Sequence Diagram(s)sequenceDiagram
participant U as User
participant P as Proxmox WebUI
participant VM as Virtual Machine
U->>U: Download & decompress HAOS image
U->>P: Initiate VM creation with CPU & memory settings
U->>P: Import the decompressed HAOS disk image into VM storage
P->>VM: Configure VM hardware (disk settings)
alt Optional Configurations
P->>VM: Add network interface and USB devices for passthrough
end
Note over VM: VM ready for Home Assistant OS installation
Tip ⚡🧪 Multi-step agentic review comment chat (experimental)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
source/_includes/installation/operating_system.md (4)
357-360: Clarity in ProxmoxVE Section Header
The new "ProxmoxVE" section is clearly added and well-organized, aligning with the documentation improvement objectives. Consider rephrasing the phrase “to a local folder storage” to “to a local storage folder” for improved readability.
387-392: Grammar and Tense Consistency for Disk Import Step
The instruction “Import the downloaded and decompressed HAOS image into the VM storage of your choice and deleted the downloaded image afterwards” would read better as “...and delete the downloaded image afterward.” This revision maintains present tense consistency and follows American English conventions.🧰 Tools
🪛 LanguageTool
[locale-violation] ~387-~387: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ...choice and deleted the downloaded image afterwards. ```bash qm importdi...(AFTERWARDS_US)
401-406: Activation Instructions: Minor Hyphenation Correction
The activation step is well described. Note a minor improvement: change “if your storage is SSD based” to “if your storage is SSD-based” to ensure proper hyphenation in American English.🧰 Tools
🪛 LanguageTool
[uncategorized] ~404-~404: The adjective “SSD-based” is spelled with a hyphen.
Context: ...d click on Add (*if your storage is SSD based, then enable the SSD emulation unde...(BASED_HYPHEN)
407-411: Typographical Correction in Network Device Step
There is a small typo in the network device step: “The network device is no attached as Network Device (net0)” should be corrected to “is not attached.” This change will improve clarity and grammatical correctness.🧰 Tools
🪛 LanguageTool
[misspelling] ~410-~410: Did you mean “not”?
Context: ...Model** 4. The network device is no attached as Network Device (net0) t...(NO_NOT)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_includes/installation/operating_system.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_includes/installation/operating_system.md
[locale-violation] ~387-~387: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ...choice and deleted the downloaded image afterwards. ```bash qm importdi...
(AFTERWARDS_US)
[uncategorized] ~404-~404: The adjective “SSD-based” is spelled with a hyphen.
Context: ...d click on Add (*if your storage is SSD based, then enable the SSD emulation unde...
(BASED_HYPHEN)
[misspelling] ~410-~410: Did you mean “not”?
Context: ...Model** 4. The network device is no attached as Network Device (net0) t...
(NO_NOT)
🔇 Additional comments (6)
source/_includes/installation/operating_system.md (6)
361-365: Clear Download Instructions
The command block provides clear, step-by-step instructions for downloading and decompressing the HAOS image. Ensure that placeholder values such as<PATH-TO-LOCAL-STORAGE>,<URL>, and<COMPRESSED-IMAGE>are documented or explained elsewhere for consistency.
367-373: Exemplary Download Command Block
The example snippet effectively demonstrates the intended usage with real values, making it easier for users to understand the process.
375-380: VM Creation Command Clarity
The instructions and the associatedqm createcommand are clear and follow ProxmoxVE best practices. The use of placeholders like<CPU-CORES>,<MEMORY-IN-MB>,<VM-NAME>, and<VMID>is appropriate, providing guidance for customization.
381-386: Effective Example for VM Creation
The provided example command, complete with specific values (e.g.,--cores 2,--memory 4096, etc.), is very helpful for users to see a concrete illustration of the VM creation process.
394-400: Clear Example for Disk Import
The example command that demonstrates how to import the disk image is clear and instructive, reinforcing the written instructions effectively.
412-416: USB Passthrough Instructions are Clear
The detailed instructions for adding USB devices for passthrough are concise and consistent with the rest of the guide. No changes are necessary here.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_includes/installation/operating_system.md (2)
357-416: New ProxmoxVE Section: Clear and Detailed GuidanceThe added ProxmoxVE tab now provides a thorough, step‑by‑step guide for setting up Home Assistant OS on ProxmoxVE. The instructions—including downloading the image, creating a new VM (with free
<VMID>), importing the disk image, and configuring both storage and network devices—are clear and practical. Using embedded bash code blocks further enhances the clarity for users performing these tasks.(Optionally, consider adding a brief note or link to Proxmox documentation regarding VMID selection and storage configuration to further assist less experienced users.)
🧰 Tools
🪛 LanguageTool
[locale-violation] ~387-~387: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ... choice and delete the downloaded image afterwards. ```bash qm importdi...(AFTERWARDS_US)
387-390: American English Consistency: Replace "afterwards" with "afterward"In the instruction text:
"Import the downloaded and decompressed HAOS image into the VM storage of your choice and delete the downloaded image afterwards."
For consistency with American English conventions (as flagged by static analysis), please change "afterwards" to "afterward."
Proposed Diff:
-... and delete the downloaded image afterwards. +... and delete the downloaded image afterward.🧰 Tools
🪛 LanguageTool
[locale-violation] ~387-~387: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ... choice and delete the downloaded image afterwards. ```bash qm importdi...(AFTERWARDS_US)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_includes/installation/operating_system.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_includes/installation/operating_system.md
[locale-violation] ~387-~387: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ... choice and delete the downloaded image afterwards. ```bash qm importdi...
(AFTERWARDS_US)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
There was a problem hiding this comment.
Our ADR doesn't support this yet. We have limited the docs instructions through the supported ADRs.
Please stay tuned, as I will open a proposal to change these (including adding proxmox support) this week.
Once that is approved, we can re-consider/re-open this one 👍
../Frenck
|
ok, will have my 👀 open for this ADR 😬 |
I think we already support ProxmoxVE official 🤔 🙈 |
Proposed change
This adds alternative installation instructions to install HAOS as VM on the popular Proxmox Virtual Environment.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit