DOCSEARCHbyAlgolia
Submit Docs

Proxmox VE Helper-Scripts

repository·main·Indexed 12 days ago

https://github.com/community-scripts/proxmoxve

One-command automated installations for services, containers, and VMs on Proxmox VE hosts (versions 8.4, 9.0, 9.1, or 9.2). Features include default and advanced installation modes, post-install helpers for service management, and data migration tools for applications like Home Assistant, Plex, and Zigbee2MQTT.

Tokens
1.2K
Snippets
5
Records
8
Agent score
49%

What's inside Proxmox VE Helper-Scripts

  1. Use post-install helpers for service management

    main

    Once a service is installed, each container includes a post-install helper accessible directly from the Proxmox shell. This helper is designed to manage the service without requiring manual configuration file editing. Common tasks include:

    • Applying updates to the installed service.
    • Changing application settings via interactive prompts.
    • Accessing basic troubleshooting tools and logs.

  2. Understand Default vs Advanced installation modes

    main

    When running an installation script, you can choose between two modes of operation:

    • Default mode: Automatically selects sensible resource defaults for CPU, RAM, and storage. It asks the minimum number of questions required to complete the setup. Most installations finish in under five minutes.
    • Advanced mode: Provides full manual control over container settings, networking, storage backends, and application-level configuration before the installation begins.

  3. Install services on Proxmox VE

    main

    You can install and configure various self-hosted services (containers or VMs) using one-line commands.

    1. Visit community-scripts.org.
    2. Search for your desired service (e.g., "Home Assistant", "Jellyfin").
    3. Copy the provided one-line installation command.
    4. Open the Proxmox Shell (root access required).
    5. Paste the command and follow the prompts.

    During installation, you will be asked to choose between two modes:

    # Example workflow (command is retrieved from community-scripts.org)
# Paste into Proxmox Shell:
# curl -sL https://community-scripts.org/install/service-name | bash

  4. Copy Home Assistant data between different installation types

    main

    Use these scripts to migrate or copy Home Assistant data between various installation environments (LXC Containers, Core, or Podman). These scripts must be executed from the Proxmox Shell.

    Migration Scenarios

    • LXC to LXC: Copy from a Home Assistant Container to another Home Assistant Container.
    • LXC to Core: Copy from a Home Assistant Container to Home Assistant Core.
    • LXC to Podman: Copy from a Home Assistant Container to Podman Home Assistant.
    • Podman to LXC: Copy from Podman Home Assistant to a Home Assistant Container.
    • Core to LXC: Copy from Home Assistant Core to a Home Assistant Container.
    • Core to Core: Copy from Home Assistant Core to another Home Assistant Core.
    # Example: Copy from Home Assistant Container to Home Assistant Core
bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/tools/copy-data/home-assistant-container-copy-data-home-assistant-core.sh)"

  6. Migrate data from Zwavejs2MQTT to Zwave JS UI

    main

    Run this script from the Proxmox Shell to migrate data from a Zwavejs2MQTT installation to a Zwave JS UI installation.

    # Copy from Zwavejs2MQTT to Zwave JS UI
bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/tools/copy-data/zwavejs2mqtt-copy-data-zwavejsui.sh)"

  8. Proxmox VE Helper-Scripts requirements

    main

    To use these scripts, your environment must meet the following requirements:

    ComponentDetails
    Proxmox VEVersion 8.4, 9.0, 9.1, or 9.2
    Host OSProxmox VE (Debian-based)
    AccessRoot shell access on the Proxmox host
    NetworkInternet connection required during installation