No description
Find a file
fcarrascosa c89f79616c
All checks were successful
Release / Bump version and tag (push) Successful in 11s
Shell checks / Bash syntax and ShellCheck (push) Successful in 22s
chore(project): initial setup
2026-11-09 16:16:23 +01:00
.githooks chore(project): initial setup 2026-11-09 16:16:23 +01:00
.github chore(project): initial setup 2026-11-09 16:16:23 +01:00
src/Host chore(project): initial setup 2026-11-09 16:16:23 +01:00
.editorconfig chore(project): initial setup 2026-11-09 16:16:23 +01:00
.gitignore chore(project): initial setup 2026-11-09 16:16:23 +01:00
CONTRIBUTING.md chore(project): initial setup 2026-11-09 16:16:23 +01:00
LICENSE chore(project): initial setup 2026-11-09 16:16:23 +01:00
README.md chore(project): initial setup 2026-11-09 16:16:23 +01:00

FCarrascosa Proxmox VE Scripts

Forgejo GitHub Mirror License

Important

Forgejo is the Source of Truth

The Forgejo repository is the canonical and authoritative source for this project.

Official Repository (Source of Truth):

https://git.fcarrascosa.tech/fcarrascosa-public/proxmoxVE-scripts

A GitHub mirror exists solely to make community participation easier:

  • Bug Reports
  • Feature Requests
  • Discussions
  • Pull Requests

GitHub Mirror:

https://github.com/fcarrascosa/proxmoxVE-scripts

All code, tags, releases, and project history originate from the Forgejo repository.

Pull Requests, Issues, and Discussions should be created on GitHub. Approved contributions are reviewed and merged into the Forgejo repository first and are then mirrored back to GitHub.

If a discrepancy ever exists between Forgejo and GitHub, the Forgejo repository should always be considered correct.

A collection of scripts for managing and automating Proxmox Virtual Environment (PVE).

This project does not aim to replace the Proxmox VE Helper Scripts. Instead, it complements them by providing additional tools, experimental features, opinionated automation, and scripts that may not fit within the scope of that project.

Philosophy

  • Keep scripts simple and easy to audit.
  • Prioritize automation and repeatability.
  • Focus on practical solutions for self-hosted environments.
  • Maintain compatibility with modern Proxmox VE releases.
  • Encourage community feedback and contributions.

Features

Documented Scripts

Every script includes documentation, usage instructions, and examples.

Modular Design

Scripts are designed to be reusable, customizable, and easy to integrate into existing workflows.

Direct Execution Support

Scripts can be executed directly from the repository while remaining fully inspectable.

Security

Always review a script before executing it.

While scripts can be executed directly using curl, it is strongly recommended that you inspect the source code first and understand what the script does before running it on your infrastructure.

Prerequisites

  • A running Proxmox Virtual Environment (PVE) host.
  • Appropriate permissions to manage VMs, containers, storage, networking, and related resources.
  • Basic familiarity with the Proxmox command line.

Usage

No repository clone is needed. Review the script source, then run it directly on a PVE host:

bash -c "$(curl -fsSL \
  https://git.fcarrascosa.tech/fcarrascosa-public/proxmoxVE-scripts/raw/branch/main/src/Host/pve-host-info.sh)"

Repository Structure

src/
├── Host/
│   └── pve-host-info.sh
├── VM/
│   └── ...
└── CT/
    └── ...

src/Host/pve-host-info.sh is a small, read-only example that reports the Proxmox VE host version. The source path above describes the repository layout; users can run the script remotely without cloning the repository.

Checks

Pull requests are checked for Bash syntax errors and ShellCheck findings. See CONTRIBUTING.md for the same checks to run locally.

Contributors can also enable the repository's optional Git hooks to run ShellCheck on staged shell scripts and validate commit messages automatically. Setup instructions and requirements are in CONTRIBUTING.md.

Requesting New Scripts

Have an idea for a new script or feature?

Please open an issue on GitHub:

https://github.com/fcarrascosa/proxmoxVE-scripts/issues

Feature requests, enhancement proposals, and bug reports are always welcome.

Contributing

Want to contribute? See CONTRIBUTING.md.

Releases

Releases are created exclusively on the Forgejo repository.

Once published, tags and releases are mirrored to GitHub.

For release information, changelogs, tags, and downloadable assets, users should consider the Forgejo repository the authoritative source.

Repository Model

This project intentionally uses two repository hosting platforms.

Forgejo (Authoritative Repository)

The Forgejo repository is the authoritative location for:

  • Source code
  • Git history
  • Tags
  • Releases
  • Project ownership
  • Official project state

Repository:

https://git.fcarrascosa.tech/fcarrascosa-public/proxmoxVE-scripts

GitHub (Community Mirror)

The GitHub repository is a public mirror used for:

  • Pull Requests
  • Issues
  • Discussions
  • Community participation

Repository:

https://github.com/fcarrascosa/proxmoxVE-scripts

Important

Changes merged through GitHub are not considered official until they have been reviewed and merged into the Forgejo repository.

If discrepancies ever exist between Forgejo and GitHub, the contents of the Forgejo repository should always be considered correct.

Source of Truth

While this project is mirrored to GitHub for community collaboration, Forgejo remains the authoritative source of truth for:

  • Source code
  • Git history
  • Branches
  • Tags
  • Releases
  • Official project state

GitHub exists primarily to facilitate community involvement and lower the barrier to contribution.

When in doubt, always refer to the Forgejo repository:

https://git.fcarrascosa.tech/fcarrascosa-public/proxmoxVE-scripts

Disclaimer

These scripts are provided "as is" without warranty of any kind.

Always test scripts and automation in a non-production environment before deploying them on systems hosting critical workloads or valuable data.