Proxmox Notes

pending

by willjasen

Create a copy of notes for assets within Proxmox.

★ 2 starsUpdated 29d agoGPL-3.0Discovered via Obsidian Unofficial Plugins
View on GitHub

obsidian-proxmox-notes

Integrate Proxmox VM and container notes within Obsidian.

Features

  • Create a one-way sync of notes from Proxmox VMs and containers into notes in Obsidian

Installation

  1. Clone or download this repository.
  2. Install dependencies: 
    npm install
  3. Build the plugin: 
    npm run build
  4. Copy files to your vault: Copy main.js, manifest.json, and styles.css to your vault's plugin folder: YourVault/.obsidian/plugins/proxmox-notes/
  5. Enable the plugin in Obsidian settings.

Configuration

Open the settings tab in Obsidian and configure:

  • Proxmox API Base URL (e.g., https://your-proxmox-server:8006/api2/json)
  • API Token (create in Proxmox, format: user@pam!tokenname=yourtoken)
  • Notes Directory (optional, defaults to vault root)

Usage

  • On startup, the plugin will generate notes for all VMs and LXCs in the configured directory.
  • Use the ribbon icon to open the Proxmox view and see your VMs and containers.
  • Notes are updated automatically when the plugin loads.

Development

This plugin uses TypeScript and the Obsidian API.

  • npm run dev — Compile in watch mode
  • npm run build — Type-check and build for production

Contributing

Pull requests and issues are welcome! Please open an issue for bugs or feature requests.

License

GPLv3

In Obsidian

Here are two screenshots of the plugin in action.

This is the folder structure of notes, with a custom vault path.

Screenshot 2025-09-16 at 8 17 37 PM

Here is a note, in which the note's contents are the same Markdown note for an example VM. Screenshot 2025-09-16 at 8 17 51 PM

Troubleshooting

  • Make sure your API token has sufficient permissions in Proxmox.
  • Check the Obsidian console for error messages if notes are not generated.

Links

For plugin developers

Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.