{"id":50822422,"url":"https://github.com/client-api/proxmox-docker-action","last_synced_at":"2026-06-13T15:03:19.045Z","repository":{"id":359984142,"uuid":"1248252488","full_name":"client-api/proxmox-docker-action","owner":"client-api","description":null,"archived":false,"fork":false,"pushed_at":"2026-05-24T12:33:25.000Z","size":176,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-24T14:08:03.116Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/client-api.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-05-24T11:52:55.000Z","updated_at":"2026-05-24T12:30:59.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/client-api/proxmox-docker-action","commit_stats":null,"previous_names":["client-api/proxmox-docker-action"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/client-api/proxmox-docker-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/client-api%2Fproxmox-docker-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/client-api%2Fproxmox-docker-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/client-api%2Fproxmox-docker-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/client-api%2Fproxmox-docker-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/client-api","download_url":"https://codeload.github.com/client-api/proxmox-docker-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/client-api%2Fproxmox-docker-action/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34288666,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-13T02:00:06.617Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-06-13T15:03:17.977Z","updated_at":"2026-06-13T15:03:19.040Z","avatar_url":"https://github.com/client-api.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# proxmox-docker-action\n\nGitHub Action that starts a\n[proxmox-docker](https://github.com/client-api/proxmox-docker) test\nimage, waits for it to become healthy, and exposes the API to the\ncaller's test steps. Cleans up at job end.\n\nSingle product per invocation. Use a matrix to start more than one.\n\n\u003e [!WARNING]\n\u003e The underlying images are test-only — hard-coded credentials,\n\u003e self-signed TLS, `--privileged` runtime. Don't expose them to the\n\u003e public internet.\n\n## Quick start\n\n```yaml\njobs:\n  e2e:\n    runs-on: ubuntu-latest\n    permissions:\n      packages: read\n    steps:\n      - uses: actions/checkout@v4\n\n      - uses: docker/login-action@v3\n        with:\n          registry: ghcr.io\n          username: ${{ github.actor }}\n          password: ${{ secrets.GITHUB_TOKEN }}\n\n      - uses: client-api/proxmox-docker-action@v1\n        with:\n          product: pve\n          tag: '9.2'\n\n      - run: pnpm test:e2e:pve\n        env:\n          NODE_TLS_REJECT_UNAUTHORIZED: '0'\n```\n\nThe action exports credentials as `PROXMOX_URL`, `PROXMOX_USER`,\n`PROXMOX_PASSWORD`, `PROXMOX_TOKEN_HEADER_VALUE`, and friends — use\n`PROXMOX_TOKEN_HEADER_VALUE` as the `Authorization:` header value\nverbatim.\n\n## Inputs\n\n| Name                | Default      | Description |\n|---------------------|--------------|-------------|\n| `product` *         | —            | One of `pve`, `pbs`, `pmg`, `pdm`. |\n| `tag`               | `latest`     | Image tag. |\n| `registry`          | `ghcr.io/client-api/proxmox-docker` | Container registry. |\n| `container-name`    | `\u003cproduct\u003e-test` | Docker container name. |\n| `host-port`         | product default | Host port (8006 PVE/PMG, 8007 PBS, 8443 PDM). |\n| `env-prefix`        | `PROXMOX`    | Prefix for env vars exported to `$GITHUB_ENV`. |\n| `enable-kvm`        | `auto`       | `auto`/`true`/`false`. With `auto`, sets up `/dev/kvm` if available. |\n| `seed-fixture-vm`   | `true`       | (PVE) Seed VM 100 (`tiny-test`). |\n| `seed-fixture-ct`   | `true`       | (PVE) Seed CT 200 (`tiny-ct`). |\n| `root-password`     | `proxmox123` | Override root@pam password. |\n| `wait-timeout`      | `120`        | Max seconds to wait for healthy. |\n\n`*` required.\n\n## Outputs\n\n| Name                    | Description |\n|-------------------------|-------------|\n| `container-id`          | Docker container ID. |\n| `container-name`        | Resolved container name. |\n| `url`                   | API URL (`https://localhost:\u003cport\u003e`). |\n| `host-port`             | Bound host port. |\n| `credentials-json-path` | Path to credentials JSON copied from the container. |\n| `kvm-available`         | `\"true\"`/`\"false\"` — gate VM-lifecycle steps. |\n| `cgroupv2-available`    | `\"true\"`/`\"false\"` — gate LXC-lifecycle steps. |\n\n## Matrix across all four products\n\n```yaml\nstrategy:\n  fail-fast: false\n  matrix:\n    product: [pve, pbs, pmg, pdm]\n\nsteps:\n  - uses: actions/checkout@v4\n  - uses: docker/login-action@v3\n    with:\n      registry: ghcr.io\n      username: ${{ github.actor }}\n      password: ${{ secrets.GITHUB_TOKEN }}\n  - uses: client-api/proxmox-docker-action@v1\n    with:\n      product: ${{ matrix.product }}\n      tag: '9.2'\n  - run: pnpm test:e2e:${{ matrix.product }}\n    env:\n      NODE_TLS_REJECT_UNAUTHORIZED: '0'\n```\n\n## Gating VM / LXC lifecycle steps\n\n```yaml\n- id: proxmox\n  uses: client-api/proxmox-docker-action@v1\n  with: { product: pve, tag: '9.2' }\n\n- name: VM lifecycle\n  if: steps.proxmox.outputs.kvm-available == 'true'\n  run: |\n    docker exec pve-test qm start 100\n    docker exec pve-test qm shutdown 100\n\n- name: CT lifecycle\n  if: steps.proxmox.outputs.cgroupv2-available == 'true'\n  run: |\n    docker exec pve-test pct start 200\n    docker exec pve-test pct exec 200 -- sh -c 'echo alpine'\n    docker exec pve-test pct stop 200\n```\n\n## Development\n\n```bash\nnpm install\nnpm run typecheck\nnpm run bundle     # rebuilds dist/main + dist/post\n```\n\n`dist/` is committed because GitHub Actions runs the bundled JS\ndirectly with no `npm install` step.\n\n## License\n\nApache 2.0 — see [LICENSE](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclient-api%2Fproxmox-docker-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclient-api%2Fproxmox-docker-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclient-api%2Fproxmox-docker-action/lists"}