Directories
¶
| Path | Synopsis |
|---|---|
|
Package agent implements hope's remote-host model.
|
Package agent implements hope's remote-host model. |
|
Package auth provides hope's single-user login: an HMAC-signed, stateless bearer token plus a sov AuthService router that mints and verifies it.
|
Package auth provides hope's single-user login: an HMAC-signed, stateless bearer token plus a sov AuthService router that mints and verifies it. |
|
Package batchstream adds a STREAMING batch endpoint at /rpc/_batchstream, as a hope-owned sov RouteHandler (no change to the sov framework itself).
|
Package batchstream adds a STREAMING batch endpoint at /rpc/_batchstream, as a hope-owned sov RouteHandler (no change to the sov framework itself). |
|
Package catalog is hope's installable-plugin catalog: the machine-readable descriptors that let hope DEPLOY a first-party plugin (pull the image, create the container with the right labels/env/volumes/networks), as opposed to merely DISCOVERING one an operator already ran.
|
Package catalog is hope's installable-plugin catalog: the machine-readable descriptors that let hope DEPLOY a first-party plugin (pull the image, create the container with the right labels/env/volumes/networks), as opposed to merely DISCOVERING one an operator already ran. |
|
Package cloudflare is a thin, typed client for the slice of the Cloudflare API hope's tunnels domain needs: a remotely-managed tunnel's ingress configuration, tunnel status, and DNS records.
|
Package cloudflare is a thin, typed client for the slice of the Cloudflare API hope's tunnels domain needs: a remotely-managed tunnel's ingress configuration, tunnel status, and DNS records. |
|
Package compose drives stack-level lifecycle by shelling out to the `docker compose` CLI, using the project/working_dir/config_files metadata that Docker stamps as container labels.
|
Package compose drives stack-level lifecycle by shelling out to the `docker compose` CLI, using the project/working_dir/config_files metadata that Docker stamps as container labels. |
|
Package config loads hope's configuration from a TOML file via viper.
|
Package config loads hope's configuration from a TOML file via viper. |
|
Package containers exposes the ContainersRouter: per-container inspect and lifecycle control.
|
Package containers exposes the ContainersRouter: per-container inspect and lifecycle control. |
|
Package deploy is hope's write path: it turns a StackSpec into running containers (create, or diff-apply against the live stack), creates the networks/volumes a deploy needs, and persists the authored spec so a stack can be reopened and edited.
|
Package deploy is hope's write path: it turns a StackSpec into running containers (create, or diff-apply against the live stack), creates the networks/volumes a deploy needs, and persists the authored spec so a stack can be reopened and edited. |
|
Package docker wraps the official Docker SDK with the small surface hope needs: list containers grouped into compose stacks by label, control a single container, and open log/stat streams.
|
Package docker wraps the official Docker SDK with the small surface hope needs: list containers grouped into compose stacks by label, control a single container, and open log/stat streams. |
|
Package events is hope's in-process event bus: producers across the daemon publish state-change events, and a single NDJSON RouteHandler (/rpc/_events) fans them out live to the frontend so the rail/sidebar and pages update without a manual refresh.
|
Package events is hope's in-process event bus: producers across the daemon publish state-change events, and a single NDJSON RouteHandler (/rpc/_events) fans them out live to the frontend so the rail/sidebar and pages update without a manual refresh. |
|
Package hostguard is the server-side backstop for host-scoped writes.
|
Package hostguard is the server-side backstop for host-scoped writes. |
|
Package hosts tracks the Docker daemons hope can drive — the local socket plus any connected agents — and which one is currently active.
|
Package hosts tracks the Docker daemons hope can drive — the local socket plus any connected agents — and which one is currently active. |
|
Package meme is a joke.
|
Package meme is a joke. |
|
Package pluginhost is hope's control plane for container plugins: it discovers containers across the fleet that declare a JSON-RPC endpoint (labels hope.plugin.*), tracks which the operator has trusted, and (in later phases) dials + renders them.
|
Package pluginhost is hope's control plane for container plugins: it discovers containers across the fleet that declare a JSON-RPC endpoint (labels hope.plugin.*), tracks which the operator has trusted, and (in later phases) dials + renders them. |
|
plugins
|
|
|
accessauth
Package accessauth is a sov RouteHandler that turns a Cloudflare Access assertion into a hope session.
|
Package accessauth is a sov RouteHandler that turns a Cloudflare Access assertion into a hope session. |
|
hosttarget
Package hosttarget is a sov ContextContributor that captures the per-request host override (the X-Hope-Host header) onto the RPC context, so a headless API caller can target a specific host per call without mutating the globally-active host.
|
Package hosttarget is a sov ContextContributor that captures the per-request host override (the X-Hope-Host header) onto the RPC context, so a headless API caller can target a specific host per call without mutating the globally-active host. |
|
introspectfilter
Package introspectfilter trims hope's /rpc/_introspect (and thus the explorer) down to the public API surface.
|
Package introspectfilter trims hope's /rpc/_introspect (and thus the explorer) down to the public API surface. |
|
logger
Package logger is hope's request-logging plugin.
|
Package logger is hope's request-logging plugin. |
|
logstream
Package logstream is a sov RouteHandler plugin that streams container logs and stats as NDJSON (application/x-ndjson, one JSON object per line) over a chunked response.
|
Package logstream is a sov RouteHandler plugin that streams container logs and stats as NDJSON (application/x-ndjson, one JSON object per line) over a chunked response. |
|
Package socketproxy is hope's opt-in, LAN-facing reverse proxy that forwards the Docker HTTP API to the unix socket behind a method/path allowlist.
|
Package socketproxy is hope's opt-in, LAN-facing reverse proxy that forwards the Docker HTTP API to the unix socket behind a method/path allowlist. |
|
Package stacks exposes the StacksRouter: the dashboard listing plus stack lifecycle.
|
Package stacks exposes the StacksRouter: the dashboard listing plus stack lifecycle. |
|
Package stackspec is hope's structured deploy model: a StackSpec (a whole compose-style stack) and its ContainerSpec services.
|
Package stackspec is hope's structured deploy model: a StackSpec (a whole compose-style stack) and its ContainerSpec services. |
|
Package store is hope's optional embedded state: a single bbolt file (pure Go, no external deps, CGO-free) at a mounted path.
|
Package store is hope's optional embedded state: a single bbolt file (pure Go, no external deps, CGO-free) at a mounted path. |
|
Package system exposes the SystemRouter: daemon-wide info and disk usage.
|
Package system exposes the SystemRouter: daemon-wide info and disk usage. |
|
Package tunnels exposes the TunnelsRouter: manage a Cloudflare tunnel's public routes per stack.
|
Package tunnels exposes the TunnelsRouter: manage a Cloudflare tunnel's public routes per stack. |
|
Package version exposes build information stamped into the binary at link time (-ldflags -X).
|
Package version exposes build information stamped into the binary at link time (-ldflags -X). |
Click to show internal directories.
Click to hide internal directories.