Skip to main content

​
Quick Start Guide

Get up and running with Proxmox VE Helper Scripts in under 5 minutes. This guide walks you through your first script installation using Docker as an example.

​
Prerequisites

Before starting, ensure you have:
1

Proxmox VE Installed

A working Proxmox VE installation (version 8.4.x, 9.0.x, or 9.1.x)
New to Proxmox? Download it from proxmox.com
2

Internet Connection

Your Proxmox host needs internet access to download scripts and packages
3

Shell Access

Access to the Proxmox shell via:
  • The web UI (node → Shell button)
  • SSH connection to your Proxmox host

​
Your First Installation: Docker

We’ll install Docker, a popular container platform, to demonstrate how simple the process is.

​
Step 1: Access Proxmox Shell

1

Via Web UI

  1. Open your Proxmox web interface at https://YOUR_PROXMOX_IP:8006
  2. Log in with your credentials
  3. In the left sidebar, click on your node name (e.g., pve)
  4. Click the Shell button in the top-right corner
2

Or Via SSH

ssh root@YOUR_PROXMOX_IP

​
Step 2: Run the Docker Installation Script

Copy and paste this command into the Proxmox shell: 
bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/ct/docker.sh)"
What does this command do?
  • curl -fsSL downloads the script from GitHub
  • bash -c executes it immediately
  • The script creates a container and installs Docker inside it

​
Step 3: Configure Installation

The script will prompt you with configuration options: 
This will create a LXC Container using the default settings.

Use Default Settings? [y/n]:
→ Press 'y' and Enter

# The script will use these defaults:
# - Container ID: Next available (e.g., 100, 101, 102...)
# - Hostname: docker
# - Disk Size: 4 GB
# - CPU Cores: 2
# - RAM: 2048 MB
# - Bridge: vmbr0
# - IP Address: DHCP
# - Container Type: Unprivileged
First time? Use simple mode (press ‘y’). You can always adjust resources later in the Proxmox UI.

​
Step 4: Wait for Installation

The script will now:
1

Create the LXC Container

Downloads the Debian 13 template if needed and creates the container
✓ Creating LXC container...
2

Start the Container

Powers on the newly created container
✓ Starting LXC container...
3

Install Docker

Runs the install script inside the container to set up Docker
✓ Setting up container...
✓ Network check passed
✓ Updating OS...
✓ Installing Docker...
Installation typically takes 2-5 minutes depending on your internet speed and server performance.

​
Step 5: Optional Add-ons

During installation, you’ll be asked: 
Would you like to add Portainer (UI)? <y/N>
Portainer provides a web UI for managing Docker containers. Highly recommended for beginners!Press ‘y’ to install it.
If you decline Portainer, you’ll be asked: 
Would you like to install the Portainer Agent (for remote management)? <y/N>
The agent allows managing this Docker instance from a centralized Portainer server.

​
Step 6: Access Your Installation

Once complete, you’ll see: 
✓ Completed successfully!

Docker setup has been successfully initialized!
If you installed Portainer, access it at the following URL:
    https://YOUR_CONTAINER_IP:9443
1

Find Your Container IP

In the Proxmox web UI:
  1. Click on your container (e.g., 101 (docker))
  2. Go to Summary tab
  3. Look for the IP address
Or in the shell:
pct exec 101 -- hostname -I
2

Access Portainer

Open your browser and go to:
https://YOUR_CONTAINER_IP:9443
Create your admin account on first login.
3

Start Using Docker

SSH into the container or use the Proxmox console:
pct enter 101
docker ps
docker run hello-world

​
What You Just Did

Congratulations! You just:

Created an LXC Container

A lightweight container running Debian 13

Installed Docker

The latest Docker Engine with Compose and Buildx

Set Up Portainer (Optional)

A web UI for managing your Docker containers

Automated Everything

All in one command, under 5 minutes

​
Next Steps

​
Try More Applications

Visit helper-scripts.com to browse 200+ available scripts:

Home Automation

Home Assistant, ESPHome, Node-RED

Media Servers

Plex, Jellyfin, Emby, Radarr, Sonarr

Network Tools

AdGuard, Pi-hole, WireGuard, Nginx

Development

GitLab, Gitea, VS Code Server

​
Update Your Container

To update Docker in the future: 
bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/ct/docker.sh)" -s update
The update command updates both Docker and Portainer to the latest versions.

​
Manage Your Container

Common Container Management Commands:
# Start container
pct start 101

# Stop container
pct stop 101

# Enter container shell
pct enter 101

# View container status
pct status 101

# Delete container (careful!)
pct destroy 101

​
Installation Pattern for Other Scripts

All scripts follow the same pattern: 
# General format:
bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/ct/SCRIPT_NAME.sh)"

# Examples:
bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/ct/adguard.sh)"
bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/ct/homeassistant.sh)"
bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/ct/nginx-proxy-manager.sh)"
bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/ct/uptimekuma.sh)"
Script names are lowercase with hyphens. Check helper-scripts.com for the exact command.

​
Troubleshooting

Make sure you’re running the command from your Proxmox host shell, not inside an existing container.Also ensure curl is installed:
apt update && apt install -y curl
Check available disk space:
df -h
Ensure your storage has enough free space for container templates and containers.
Verify Proxmox network configuration:
ip a
ping -c 4 8.8.8.8
Check that your bridge (vmbr0) is properly configured in Proxmox.
  1. Verify the container is running: pct status 101
  2. Check the container’s IP: pct exec 101 -- hostname -I
  3. Ensure port 9443 is not blocked by a firewall
  4. Try accessing via IP shown in the success message

​
Get Help

If you run into issues:

Discord Community

Ask questions in real-time

GitHub Discussions

Browse Q&A and community tips

Report Issues

File bug reports if needed

​
What’s Next?

Learn Installation Methods

Discover all the ways to use these scripts

Browse All Scripts

Explore 200+ available applications

Build docs developers (and LLMs) love

Get started for freeTalk to us