KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#typescript #ai-agents #developer-tools #codex #claude-code #cli #react #mcp #open-source #deepseek-harness #dsh-plugin #ai

pve-notebuddy

★ 201 Open GitHub ↗

Generate pretty Proxmox Guest Notes with a simple web based UI

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">
  <img src="resources/icons/notebuddy-logo.svg" height="80px" alt="PVE NoteBuddy Logo" />
  <h1>PVE NoteBuddy</h1>
  <p><em>Generate pretty Proxmox Guest Notes with a simple web based UI</em></p>

**with Proxmox 9.2.0 and newer, there is additional santization in the widget-renderer, which restricts base64 SVG strings from being rendered. This means that embedding SVGs with NoteBuddy is currently not possible anymore. Resizing with wsrv.nl works as intended.**

[![CodeQL](https://github.com/jangajones/pve-notebuddy/actions/workflows/codeql.yml/badge.svg)](https://github.com/jangajones/pve-notebuddy/actions/workflows/codeql.yml) [![CI](https://github.com/jangajones/pve-notebuddy/actions/workflows/ci.yml/badge.svg)](https://github.com/jangajones/pve-notebuddy/actions/workflows/ci.yml)

**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.**
 
🚧  Plan for the next weeks: Updating the documentation in smaller increments, a lot of it is still "lorem ipsum". Documentation takes longer than expected. 🚧

</div>

<div align="center">
  <sub>🙌 <strong>Shoutout to</strong></sub>
  <br />
  <br />
  <a href="https://helper-scripts.com">
    <img src="https://img.shields.io/badge/community--scripts-Proxmox_VE_Helper--Scripts-0298a1?style=for-the-badge&labelColor=25787d" alt="Community-Scripts" />
  </a>
  <br />
  <sub><a href="https://github.com/community-scripts/ProxmoxVE">View on GitHub</a> • Used their PocketBase DB to generate template files</sub>
<br />
<br />
  <a href="https://selfh.st/">
    <img src="https://img.shields.io/badge/selfh.st-Icons_for_Self--Hosted-2563eb?style=for-the-badge&labelColor=1e3a8a" alt="selfh.st Icons" />
  </a>
  <br />
  <sub><a href="https://github.com/selfhst/icons">View on GitHub</a> • Consistent, beautiful icons for 5000+ self-hosted apps</sub><br>
  <sub>Huge thanks for including NoteBuddy in the icon collection!</sub>
</div>
<br />

# 🚀 Features

- Clean & lightweight, fully client-side app
- Ready to paste Proxmox Guest Notes via Copy-HTML button
- Preview pane that displays notes just like the PVE Web UI would (also supports dark/light mode)
- Over 500 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](https://wsrv.nl/)** (Open-Source, uses Cloudflare as CDN)
- Icon Search Pane for quick copy-paste of icon links
- Supports **[selfh.st](https://selfh.st/)** icon links natively, you can switch between their icon variants directly from the UI
- Fields for various information like guest name, FQDN, networking & config paths
- Custom Note field to use for styling or to input additional information (supports **[Markdown](https://www.markdownguide.org/basic-syntax/)** HTML tags)
- Alignment, re-order & text styling options for every field, many possible designs
- Uses local browser storage for internal Template Manager

# 🗒️ Examples

<div align="center">
<p>A collection of screenshots from the preview pane</p>
<p align="middle">
      <img src="docs/source/public/images/1.png" width="49%" />
      <img src="docs/source/public/images/2.png" width="49%" />
</p>
<p align="middle">
      <img src="docs/source/public/images/3.png" width="49%" />
      <img src="docs/source/public/images/4.png" width="49%" />
</p>
<p align="middle">
      <img src="docs/source/public/images/5.png" width="49%" />
      <img src="docs/source/public/images/6.png" width="49%" />
</p>
<p align="middle">
      <img src="docs/source/public/images/7.png" width="49%" />
      <img src="docs/source/public/images/8.png" width="49%" />
</p>

</div>

## Help! How can I use old templates from pre v1.5.0?
You can use the import feature in the Template Manager. I've wired an legacy importer that detects older .json exports and should take care of compatibility. I haven't encountered any bugs in my testing - if your import does fail, feel free to open up an issue and I will take a look at it.

## Local Deployment & Template Scripts

Please refer to the [documentation](https://jangajones.github.io/pve-notebuddy/docs/).

## Frequently Asked: API & Automation

Currently API & Automation (e.g. automatic publishing to Proxmox or fetching the HTML Output via request) is not planned, since this would require a backend and therefore only weaken robustness and security. For the time being, PVE NoteBuddy will definitely remain separate from Proxmox VE or any automation/deployment tools.

## AI Disclaimer & Security

This project leverages AI to assist with development. Code contributions generated or modified with the help of AI tools are thoroughly reviewed and tested by myself before release.

_PVE NoteBuddy is a fully client-side application with no backend & no telemetry. The live version is directly hosted on GitHub Pages. Based on its design and my own review, I consider it safe to use. Be cautious about other distributed forks/clones (as with any other repo) that may contain malware. This project is actively maintained, the latest releases will exclusively be available through this GitHub repository._

## Project Statistics

---

<div align="center">
  <sub><i>Proxmox® is a registered trademark of <a href="https://www.proxmox.com/en/about/company">Proxmox Server Solutions GmbH</a></i></sub>
</div>

pve-notebuddy

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README