You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
> - Avoid exposing the API key in your shell history: export it to a variable (`export ADMIN_REGISTER_KEY=...`) and use `-H "x-api-key: $ADMIN_REGISTER_KEY"`.
81
+
> - Change the password and registration key in real environments.
82
+
83
+
---
84
+
27
85
## Build Agent Tools (Windows helpers)
28
86
29
-
These binaries are required by the PowerShell Agent to create cloud‑init ISOs and to bridge serial consoles.
87
+
These binaries are required by the PowerShell Agent to create **cloud-init ISOs** and to bridge **serial consoles**.
30
88
31
89
**Layout:**
32
90
@@ -53,7 +111,9 @@ This will:
53
111
54
112
> If you build manually, ensure you build `src/` first, then the tools, then move outputs to `/src/powershell/bin`.
55
113
56
-
## Running the Agent (on a Hyper‑V host)
114
+
---
115
+
116
+
## Running the Agent (on a Hyper-V host)
57
117
58
118
1. Copy the folder `src/powershell/` and its `bin/` subfolder (containing the built `.exe`) to the Windows host.
59
119
2. Open an elevated PowerShell.
@@ -86,8 +146,10 @@ This will:
86
146
# .\openhvx-agent.exe
87
147
```
88
148
149
+
---
150
+
89
151
## Next Steps
90
152
91
153
- Read: **Overview → Architecture & Features**
92
-
- Contribute: open issues/PRs on GitHub:[https://github.com/openhvx](https://github.com/openhvx)
154
+
- Contribute: open issues/PRs on GitHub →[https://github.com/openhvx](https://github.com/openhvx)
Each VM exposes a live serial console, **established as a tunnel** between the **client browser** and the **Agent**, with the **WebSocket Broker** acting as an intermediary relay.
55
+
The broker maintains secure, tenant-scoped channels, ensuring that only authenticated users can attach to their own virtual machines.
56
+
57
+
This architecture provides near real-time console streaming, independent of the hypervisor’s native UI or RDP, and works even in fully headless environments.
58
+
59
+
<imgsrc="/assets/serial-console.png"alt="OpenHVX Serial Console"width="900"data-zoomable />
60
+
61
+
---
62
+
42
63
### 🤝 Contributing
43
64
44
65
We welcome contributions from the community! Whether it’s documentation improvements, feature suggestions, or bug reports — every input helps make OpenHVX better. Visit the [GitHub organization](https://github.com/openhvx) to get started.
0 commit comments