Community
Open source, Apache 2.0-licensed, alpha
Portoser is built in the open. The main contributor's home-lab is the primary deployment target, which means defaults occasionally assume that environment — and which means real-world feedback from a different shape of cluster is exactly what makes the project better.
Where to find us
GitHub
The source. Read the code, file issues, send PRs. The fastest way to get a human eye on a real bug.
Browse the repo
Issues
Bug reports, feature requests, design discussion. Search before you file — the answer might already be there.
See open issues
Releases
Tagged releases with changelog. The alpha is moving — check here before assuming a feature is in your version.
Latest releases
Documentation
Full docs site with concepts, hardware setups, operations, reference, and an FAQ.
Read the docs
Ways to contribute
Try it
Run the 5-minute demo. Tell us what was unclear or what broke.
Report what doesn't work
A repro and your environment is enough. Issues with portoser registry validate output and the relevant section of registry.yml are the most actionable.
Improve docs
Found a wrong claim, a dead link, or a missing gotcha? PRs to portoser_docs_website are welcome.
Add a hardware setup
Running on hardware nobody else has documented? Open a PR with a hardware-setups/<your-shape>.md walkthrough.
Write an MCP tool
The MCP server is wired and waiting. Register tools that operate on the cluster and share them.
Contribute code
Read CONTRIBUTING.md. Tests are required (500+ exist across the CLI and web backend; we don't merge regressions).
Project status: alpha
APIs may change. Some defaults assume the maintainer's home-lab. The platform parts (registry schema,
web UI, MCP server, lib/ orchestration primitives)
are designed to be reusable; the example cluster layout is not the only valid one.
Issues and PRs are welcome.