Start Here
Setup
Install Gooselake, run the runtime locally, and get to the first working control plane.
What you are starting
Gooselake is not a theme, SDK snippet, or browser widget. You are starting a machine-side runtime that exposes agent control over HTTP and SSE while keeping execution close to the host.
That means your first success criterion is simple:
- the runtime installs cleanly
- you can launch it with a local config
- a frontend or operator can connect without embedding orchestration logic in the client
Local install
Use the repo helpers for the fastest local path:
make install
cp "$HOME/.local/runtime-server.toml.example" ./runtime-server.toml
gg-runtime-server --config ./runtime-server.toml
The runtime server becomes the machine-local entrypoint for session creation, streaming, and execution.
What to verify first
Before introducing a custom UI or workflow, confirm three things:
- The server boots with your config and does not fail on provider initialization.
- You can reach the HTTP surface and observe SSE output.
- The machine has the provider and host permissions your agents will actually need.
Deployment path
For a Linux VPS or long-lived host, the repo already includes deployment guidance and systemd examples:
make vps-deploy
Once deployed, treat the runtime host as the durable execution boundary. Your client can come and go. The service should not.
Related repo docs
The repository also ships deeper operational docs under the existing docs/ directory, including install, deployment, API, and architecture notes. This website is the guided front door; the repo docs are the detailed operating manual.