https://github.com/hjongedijk/cloudinit-preinstall
Scripts and guides for deploying Debian VMs on Proxmox VE with automated cloud-init preinstallation.
https://github.com/hjongedijk/cloudinit-preinstall
automation cloud-init debian docker filebrowser monitoring proxmox templates vm
Last synced: about 2 months ago
JSON representation
Scripts and guides for deploying Debian VMs on Proxmox VE with automated cloud-init preinstallation.
- Host: GitHub
- URL: https://github.com/hjongedijk/cloudinit-preinstall
- Owner: hjongedijk
- License: mit
- Created: 2025-09-16T14:56:30.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2026-04-18T10:05:16.000Z (2 months ago)
- Last Synced: 2026-04-30T12:33:37.412Z (about 2 months ago)
- Topics: automation, cloud-init, debian, docker, filebrowser, monitoring, proxmox, templates, vm
- Language: Shell
- Homepage: https://github.com/hjongedijk/cloudinit-preinstall
- Size: 57.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Proxmox Debian VM Setup & Cloud-Init Preinstall
This repository provides a fast path to deploy Debian 12/13 VMs on **Proxmox VE** and prepare them for **cloud-init** with an interactive, menu-driven preinstall script.
- Creates a Debian VM using the community one-liners (Debian 12 or 13)
- Runs `cloudinit-preinstall.sh` inside the VM to apply sane defaults
- (Optional) Deploys **Filebrowser** and a **Monitoring** stack via Docker
- Cleans cloud-init state so your template is ready for cloning
---
## 📑 Index
- [✅ Quick Start](#-quick-start)
- [🧰 What the script does](#-what-the-script-does)
- [⚠️ Notes & Warnings](#️-notes--warnings)
- [📋 Example Workflow](#-example-workflow)
- [🔑 Filebrowser Default Credentials](#-filebrowser-default-credentials)
- [🤝 Contributing](#-contributing)
- [📜 License](#-license)
---
## ✅ Quick Start
### 1) Create a Debian VM in Proxmox
**Debian 12**
```bash
bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/vm/debian-vm.sh)"
```
(Source: [Proxmox VE Helper-Scripts](https://community-scripts.github.io/ProxmoxVE/scripts?id=debian-vm&category=Operating+Systems))
---
**Debian 13**
```bash
bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/vm/debian-13-vm.sh)"
```
(Source: [Proxmox VE Helper-Scripts](https://community-scripts.github.io/ProxmoxVE/scripts?id=debian-13-vm))
---
### 2) Run the Cloud-Init Preinstall (inside the VM)
Open **Proxmox → your VM → Console (xterm.js)** and log in as `root`, then:
```bash
bash -c "$(curl -fsSL https://raw.githubusercontent.com/hjongedijk/cloudinit-preinstall/main/cloudinit-preinstall.sh)"
```
- Choose **1) Run ALL steps** or run individual steps as needed.
- At the end you’ll get a clear **installation overview** and an **optional shutdown** prompt.
---
## 🧰 What the script does
The script is interactive and idempotent where possible.
### When run as **non-root**
- Prompts to set/unlock the **root password**
- Enables **SSH root login + password auth**
- Restarts **SSH**
- Prints follow-up steps and asks to logout
### When run as **root**
Runs full setup (via menu or run-all):
1. 🔄 Update & upgrade system packages
2. 📦 Install base tools (`sudo`, `curl`, `wget`, `git`, `htop`, `fail2ban`, etc.)
3. 🔐 Set and unlock `root` password
4. 🔧 Configure SSH (`PermitRootLogin` + `PasswordAuthentication` **enabled**)
5. 🧹 Remove an existing user (optional, interactive), if VM only needs to have **root** user
6. 🕰️ Set timezone → `Europe/Amsterdam`
7. 🧰 Install `qemu-guest-agent`, `zip`, `unzip`, and **enable** `getty@tty1` for **Default (VNC console)**
8. 🐍 Install Python 3, pip, venv, dev tools
9. 🐳 Install Docker CE + Compose plugins
10. 🔌 Configure Docker to listen on `unix:///var/run/docker.sock` and `tcp://0.0.0.0:2375` (**⚠️ insecure**)
11. 👥 Grant Docker access (via group or chmod 666)
12. 📁 Deploy **Filebrowser** bundle (`/opt/filebrowser`)
13. 📊 Deploy **Monitoring** bundle (`/opt/monitoring`)
14. 🧽 Clean cloud-init state and apt cache
15. 📴 Prompt for shutdown (optional)
---
## ⚠️ Notes & Warnings
- Always run as **root** for the full installer.
- Docker TCP (2375) is **unsecured** — only use on trusted networks.
- After running, configure cloud-init in Proxmox (`user`, `password`, `ip=dhcp`) and **regenerate image**.
- After enabling **getty@tty1** you can safely remove the serial port and set Display → **Default (VNC console)**.
- **Security Reminder**: Always review and understand scripts before executing them on your server. Do not blindly run one-liners from the internet without inspection.
---
## 📋 Example Workflow
1. Deploy Debian VM (12 or 13) via community script.
2. Boot the VM, open **Console (xterm.js)**, log in as `root`.
3. Run the preinstall script:
```bash
bash -c "$(curl -fsSL https://raw.githubusercontent.com/hjongedijk/cloudinit-preinstall/main/cloudinit-preinstall.sh)"
```
4. Choose **Run ALL** (or step through interactively).
5. Shut down the VM when done.
6. Configure **cloud-init** in Proxmox and regenerate image.
7. Optional remove the **Serial Port (serial0)** from VM Hardware and set **Display** to Default.
8. Convert the VM to template.
9. VM template is now **ready for cloning & production use** 🚀
---
## 🔑 Filebrowser Default Credentials
By default, the **Filebrowser** bundle (`/opt/filebrowser`) is initialized with this admin account:
- **Username:** `admin`
- **Password:** `XRYCRko11zRFkL`
⚠️ **IMPORTANT:** You must change this password immediately after your first login to ensure security.
To change the password, open the Filebrowser web UI (by default exposed on port **8079**) and update the admin account credentials under the user settings.
---
## 🤝 Contributing
Contributions are welcome!
- 🪄 **Fork** the repository
- 🌱 **Create** a feature branch (`git checkout -b feature/my-change`)
- 💾 **Commit** your changes (`git commit -m "Add my feature"`)
- 📤 **Push** the branch (`git push origin feature/my-change`)
- 🔀 **Open a Pull Request**
Please keep contributions focused, and describe clearly what your change improves.
---
## 📜 License
This project is licensed under the **MIT License** — see the [LICENSE](./LICENSE) file for details.
You are free to use, modify, and distribute it, provided the license terms are respected.
---
## ⚖️ Disclaimer
This project is provided **as-is** without warranty of any kind.
The author(s) are **not responsible for any damage, data loss, misconfiguration, or security issues** resulting from the use of these scripts.
By using this repository, you agree that **you run all scripts at your own risk** and that you are responsible for reviewing them before execution.