Skip to content

Document Proxmox LXC and Community Scripts install path #23

Description

@ggfevans

Context

Rackula now has a Proxmox VE Helper-Scripts entry for LXC installs:

The docs currently cover Docker self-hosting, but not Proxmox/LXC. Homelab users coming from Proxmox should have a clear, documented install path instead of discovering it through the community scripts site by moonlight.

Proposed work

Add Proxmox/LXC install documentation under src/content/docs/self-hosting/, either as a new page such as proxmox-lxc.mdx or as a clearly linked section from the existing self-hosting docs.

Include:

  • A short explanation of when to use the Proxmox LXC path versus Docker.
  • The Community Scripts page link.
  • The command users run from the Proxmox VE shell:
bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/ct/rackula.sh)"
  • A note that this creates a Rackula LXC container.
  • Current script details worth documenting or verifying while writing:
    • install target: LXC
    • container: unprivileged
    • ARM support: yes
    • default port: 80
    • generated API write token location: /opt/rackula/data/.env
  • A cautious third-party script note: users should review the script before piping it into bash; link to the raw script and/or upstream Community Scripts repo.
  • Expected post-install steps, including where to find the running service and any Rackula-specific persistence/API-token behaviour that differs from the Docker docs.
  • Links from relevant entry points, likely the docs home page self-hosting card and/or the Docker deployment page.

Acceptance criteria

  • Proxmox is spelled correctly throughout.
  • Uses Canadian/British spelling where applicable.
  • LXC/community-script install path is discoverable from the self-hosting docs.
  • Security caveat is present without making the page sound like legal embalming fluid.
  • npm run build passes.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:contentDocumentation contentdocumentationImprovements or additions to documentationreadyReady for implementationsize:smallSmall effort

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions