Skip to content

Node.js library for interacting with the Proxmox API. It provides a simple and lightweight wrapper around the Proxmox API, making it easier to manage your Proxmox virtual environments from a Node.js application.

Notifications You must be signed in to change notification settings

n01rdev/delirium-proxmox

Repository files navigation

Delirium Proxmox Library

Node.js library for interacting with the Proxmox API. It provides a simple and lightweight wrapper around the Proxmox API, making it easier to manage your Proxmox virtual environments from a Node.js application.

Features

  • Authentication with Proxmox server
  • Fetching nodes, storages, networks, and CPU information
  • Creating and configuring virtual machines
  • Resizing virtual machine disks
  • Fetching Proxmox server version

Installation

To install the Delirium Proxmox Library, use the following command in your Node.js project:

npm install delirium-proxmox

Usage

First, import the necessary services from the library:

import { DeliriumClient } from 'delirium-proxmox';

Then, create an instance of the `ProxmoxService` and use its methods to interact with the Proxmox API:

const deliriumClient = new DeliriumClient();
// Use the client...

Peer Dependencies

This library has the following peer dependencies, which should be installed in your project:

  • `@nestjs/axios`
  • `@nestjs/common`
  • `@nestjs/core`
  • `@nestjs/platform-express`
  • `axios`
  • `reflect-metadata`
  • `rxjs`
  • `tough-cookie`

License

This project is licensed under the MIT License. See the LICENSE.md file for details.

Author

  • Álvaro Diago de Aguilar - GitHub

Contributing

Contributions are welcome. Please open an issue or submit a pull request on GitHub.

About

Node.js library for interacting with the Proxmox API. It provides a simple and lightweight wrapper around the Proxmox API, making it easier to manage your Proxmox virtual environments from a Node.js application.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published