From 45135aa5db02b1e01fc2e55c844b77e5ab8b3b65 Mon Sep 17 00:00:00 2001 From: Kroese Date: Thu, 2 Jul 2026 11:16:59 +0200 Subject: [PATCH] docs: Readme (#65) --- readme.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/readme.md b/readme.md index d224bd7..ab20f59 100644 --- a/readme.md +++ b/readme.md @@ -25,7 +25,7 @@ Proxmox VE inside a Docker container. ## Usage 🐳 -##### Via Docker Compose: +##### Docker Compose: ```yaml services: @@ -45,13 +45,13 @@ services: stop_grace_period: 2m ``` -##### Via Docker CLI: +##### Docker CLI: ```bash docker run -it --rm --name proxmox --hostname pve --privileged -e "PASSWORD=root" -p 8006:8006 -v "${PWD:-.}/data:/var/lib/vz" -v "${PWD:-.}/config:/var/lib/pve-cluster" --stop-timeout 120 docker.io/dockurr/proxmox ``` -##### Via Github Codespaces: +##### GitHub Codespaces: [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/dockur/proxmox) @@ -61,6 +61,15 @@ docker run -it --rm --name proxmox --hostname pve --privileged -e "PASSWORD=root +## Requirements ⚙️ + +- A Linux host with KVM support, or Docker Desktop / Podman on Windows 11 with nested virtualization enabled. +- At least 2 GB of RAM available. +- At least 32 GB of free disk space. + +> [!NOTE] +> Docker Desktop on macOS and Windows 10 do not currently provide the required KVM support for this image. + ## FAQ 💬 ### How do I use it? @@ -123,7 +132,7 @@ docker run -it --rm --name proxmox --hostname pve --privileged -e "PASSWORD=root - you enabled "nested virtualization" if you are running the container inside a virtual machine. - - you are not using a cloud provider, as most of them do not allow nested virtualization for their VPS's. + - you are not using a cloud provider, as most of them do not allow nested virtualization for their VPSs. ## Acknowledgements 🙏