Generate pretty Proxmox Guest Notes with a simple web based UI
Use a broad palette of templates for your self-hosted services &
adjust them to your needs or create notes fully from scratch in a few seconds.
🚧 Upcoming Version 1.5.0 is currently planned for mid to late April! 🚧
It will include a lot of new features and a complete UI overhaul
You are welcome to clone the dev branch to take a sneak peek.
Feel free to open up an issue for feature requests/bugs/other inquiries.
View on GitHub • Used their PocketBase DB to generate template files
View on GitHub • Consistent, beautiful icons for 5000+ self-hosted apps
Huge thanks for including NoteBuddy in the icon collection!
- Clean & lightweight, fully client-side app
- Direct HTML-Output copy button, ready to paste to PVE Notes
- Preview pane that displays notes just like the PVE Web UI would (also supports dark/light mode)
- Over 400 templated services (Logo, Website, Default Ports, Default Config Location)
- Directly embed resizable SVGs from local or external sources (fully offline available, no CDN needed, vector quality)
- Option to resize external images via wsrv.nl (Open-Source, uses Cloudflare as CDN)
- Supports selfh.st icon links natively, you can switch between their icon variants directly from the UI
- Fields for thinks like guest name, FQDN, networking & config paths
- Custom Note field to use for styling or to input additional information (supports Markdown HTML tags)
- Alignment, re-order & text styling options for every field, many possible designs
- Import & export to save your own designs
A collection of screenshots from the preview pane
In the crawl-scripts folder inside the repo there are are 2 scripts, one to crawl content from the community-scripts repo (crawl.mjs) and a second script (generate-templates.mjs) to transform the .json files in their repositoy into usable NoteBuddy .json files. Thanks to their curated repo, NoteBuddy is able to provide over 400 service templates with names, icons, website links, default ports & default config locations.
Massive shoutout to them! 🤝
The crawl-scripts are only needed to commit template updates to this repo and are not used by NoteBuddy itself.
PVE NoteBuddy is static & client-side. For local use, deploy the contents of the main branch to any static web server, or run a lightweight local server directly from the repository root.
Clone the repository and serve the project directory with your preferred static hosting solution.
git clone --branch main https://github.com/JangaJones/pve-notebuddy.gitExamples:
- Nginx
- Apache
- Caddy
- any simple static file host
git clone --branch main https://github.com/JangaJones/pve-notebuddy.git
cd pve-notebuddy
python3 -m http.server 8000Then open:
http://localhost:8000
Do not open index.html directly via file://. NoteBuddy won't work as intended this way.
The app loads template JSON files dynamically, and modern browser blocks those local fetch() requests when opened directly from disk. This results in template loading failures caused by browser CORS/security restrictions. Use a local or self-hosted static web server instead.
Currently API & Automation (e.g. automatic publishing to Proxmox or fetching the HTML Output with a GET Request) is not on the table, since this currently exceeds my skillset and would only weaken robustness and security. PVE NoteBuddy will remain separate from Proxmox or automation/deployment tools. This may or may not change in the future.
NoteBuddy is a fully client-side application with no backend, no telemetry, with the live version directly hosted on GitHub Pages. Based on its design and my own review, I consider it safe to use. Always be cautious about other distributed forks/clones that may contain malware. This project is actively maintained, there is no need to download or use it from another source.
Security in vibe-coded/AI-assisted apps is something I take seriously. For transparency, I did use an AI agent for parts of the development process, including certain features, troubleshooting, and boilerplate code. However, large portions of the codebase are still written and maintained manually.
Every commit has been thoroughly reviewed and tested by me. I'm a hobbyist developer with many years of hands-on experience with HTML and JavaScript long before we had AI to assist us.
