Add Proxmox VE
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 80/100
- Issue type
- Feature
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- javascript
- Domain
- api
Research direction
Read docs/ADDING_APPS.md, then look at the gitea definition in src/catalog/apps/batch-19.js to see how a self-hosted app takes a url field. Add a Proxmox VE definition to the most fitting file in src/catalog/apps/, with an API token auth field and help text that covers the self-signed certificate. Done when npm run validate and npm test pass and the logo is generated with npm run logos -- <app id>.
Written by the indexing model from the issue text.
Description
Add Proxmox VE to the catalog. It's a popular self-hosted app and a good first contribution: Conector already supports apps on your own server through a url field.
API documentation: https://pve.proxmox.com/wiki/Proxmox_VE_API
What we know so far (check it against the docs before relying on it):
- Base URL:
{url}/api2/json(usuallyhttps://<host>:8006), where{url}is a field withformat: "url"(see thegiteaapp insrc/catalog/apps/batch-19.jsfor an example). - Authentication: An API token (Datacenter → Permissions → API Tokens), sent as
Authorization: PVEAPIToken=USER@REALM!TOKENID=SECRET. Many installs use a self-signed certificate: say so in the help text. - Connection test:
GET /versionreturns the Proxmox VE version. - What agents could do with it: List nodes, VMs and containers, check their status, start and stop them.
How to add it
- Follow docs/ADDING_APPS.md: add the definition to the most fitting file in
src/catalog/apps/, with help text that leads people to the key in a few numbered steps. - Run
npm run validateandnpm test, and generate the logo withnpm run logos -- <app id>. - If you run Proxmox VE yourself, connect it in a local Conector and try a couple of requests from your agent. Say in the pull request what you tested.
Comment here if you'd like to take it, so nobody else starts the same work.
- Dominant language
- JavaScript
- Stars
- 1
- Forks
- 1
- Avg merge
- 19h 5m
- Merged PRs (30d)
- 26
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
glossyio/traffic-monitor#255 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
juice-shop/juice-shop#3706 ·
Maintainers usually reply within 1 day
-
Main workflow runs twice for newly created refsPossibly taken @rustyconover claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
duckdb/duckdb-wasm#2293 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
521xueweihan/HelloGitHub#4115 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
outline/outline#14348 · 1 comment ·
Maintainers usually reply within 1 day