PVE NoteBuddy Documentation

PVE NoteBuddy is a static, client-side web app for generating pretty Proxmox VE guest notes fast and easy.

Use this documentation to learn:

• what the app does and how it works
• how templates, snapshots, designs and settings function
• how to self-host
• how to contribute to the project

Work in Progress

Parts of the documentation are still work in progress:

• How To Use
• Templates
• Self-Hosting
• Configuration

Documentation Quick Start

• Introduction
• Should I Self-Host?
• How To Use
• Template Search
• Designs
• Snapshots
• Settings
• FAQ

Security Note

Be cautious with unofficial forks that advertise pre-packaged downloads. A fork can change JavaScript behavior and still look visually identical.

Use the official project repository and official GitHub Pages deployment. Be careful with third-party forks that offer downloads or modified builds. A malicious fork can inject unsafe code into a static app.

Official sources:

• GitHub repository: https://github.com/JangaJones/pve-notebuddy
• Live app: https://jangajones.github.io/pve-notebuddy/