Kerbside, a SPICE VDI proxy
Kerbside is a SPICE VDI protocol proxy: a pure-Python control plane (the REST API and the daemon) that supervises a Rust SPICE proxy. It sits out the front of your cloud and provides VDI access to VMs running inside the cluster, determining what VM to proxy your traffic to based on the password you provide when connecting. Unlike layer 4 proxies that pass through unparsed traffic, Kerbside understands the SPICE protocol itself — the proxy terminates TLS, drives the SPICE link handshake, and is an enforcing SPICE application firewall, on by default.
Kerbside currently knows how to proxy console sessions for Shaken Fist, OpenStack, oVirt, and Proxmox VE. It will mostly be of interest to operators of those clouds who want to offer users rich native SPICE desktops (high resolution, multi-monitor, USB passthrough, audio) instead of HTML5-transcoded consoles. OpenStack is probably the best documented integration at the moment because there are patches to add deployment support for Kerbside to Kolla-Ansible in the kerbside-patches repository.
Kerbside is currently considered experimental: it works, but it has not yet seen large scale deployment.
Installation
pip install kerbside
This installs the Python control plane and a matching prebuilt
kerbside-proxy binary wheel automatically (x86_64 and aarch64). See
docs/installation.md
for the packaging details, OS-level dependencies, and deployment pointers.
If you would rather see it working first, demo/ brings the whole stack
up under docker compose and hands you a proxied console.
Documentation
In the docs/ directory:
- Documentation Index - What Kerbside is, the broker model, and the connection flow
- Use Cases - One page per cloud or topology — oVirt, Proxmox VE, Shaken Fist, OpenStack, standalone, plus the multi-cloud and placement topologies — each covering the value proposition, how it works, and how to set it up
- Deployment Options - How to run Kerbside for real: one page per mechanism (by hand, Ansible, Kolla-Ansible, containers), with the sources each configures and what CI tests
- Installation - From
pip installto a proxied console: what a running Kerbside needs, the compose demo, and a pointer to the deployment pages: by hand, Ansible, Kolla-Ansible and containers - Configuration - Configuration reference, including the SPICE firewall knobs
- Console Sources - Configuring sources.yaml for Shaken Fist, OpenStack, oVirt, and Proxmox VE
- Proxy Architecture - Internal proxy design, state machine, and firewall
- Database Schema - Tables, columns, and relationships
- SPICE Protocol Documentation - Protocol fundamentals, link handshake, per-channel message formats, compression, capabilities, USB redirection, and the VD agent protocol (under
docs/spice/) - Development - Migrations, building and packaging the Rust proxy, dependency pinning, review tracking, vendored web assets, and debugging
- Testing - Running the test suite, CI tiers and lane mechanics, Ryll harnesses, the oVirt console probe, Tempest, and load-test images
Project reference files:
- ARCHITECTURE.md - High-level system architecture
- AGENTS.md - AI agent guidelines for working on this codebase
- .claude/ - Claude Code project instructions and skills (database migrations, adding source types)
License
Apache-2.0
Metadata
Release files for kerbside 0.9.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| kerbside-0.9.0.tar.gz | 1.8 MB | With provenance | Details for kerbside-0.9.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| kerbside-0.9.0-py3-none-any.whl | Python 3 | none | any | Details for kerbside-0.9.0-py3-none-any.whl |
Total release size: 2.0 MB
Release files / kerbside-0.9.0.tar.gz
| Download URL | kerbside-0.9.0.tar.gz |
|---|---|
| Size | 1.8 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ced7b2a27115d7ad92a28358a4a511caeab64a3bbbc50afede0b13007ba8c7b0
|
|
BLAKE2b-256 checksum How to use checksums |
9eb1b784de16a803afa2c8fc04db8eebeaaead59aedd798073e50f5cb0a9cb6d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 4, 2026.
Transparency logRelease files / kerbside-0.9.0-py3-none-any.whl
| Download URL | kerbside-0.9.0-py3-none-any.whl |
|---|---|
| Size | 184.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
194b7f3cac07da8aaeadfbb1c38c533520cac7de1d1178199a6f47684a7d6679
|
|
BLAKE2b-256 checksum How to use checksums |
2922f7c7443eec13e187651d75b82298a7f3eae85251cc45ca460889c9047f57
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 4, 2026.
Transparency logSecurity for kerbside 0.9.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for kerbside-0.9.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 4, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.