Skip to content
Railgrid Docs
Sections
Open console

Enter a topic to search documentation.

    Hub deployment

    Install, configure, secure, and operate a self-hosted Railgrid hub.

    Run the Railgrid hub on your own infrastructure. Choose an installation path, configure access, and establish storage and recovery procedures before onboarding workspaces.

    What a hub deployment contains

    ComponentRoleWhere it is documented
    HubConsole, API, provider registry, kubeconfig minting. Serves HTTPS on :9443.Install the hub
    kcpThe control plane every workspace and provider API lives in. Embedded in the hub pod, or external shards you operate.External kcp
    Dex (or another OIDC issuer)Signs users in. kcp and the hub both verify its tokens.OIDC
    IngressCarries the console, the issuer, kcp, and published apps under public hostnames with TLS.Ingress , Gateway API , Cloudflare Tunnel
    ProvidersCapabilities users enable in workspaces. Each is its own chart in its own namespace.Provider hosting

    Hostnames you will need

    Plan these before installing anything; several of them are baked into certificates, kubeconfigs, and OIDC client registrations.

    HostnameServed byNeeded when
    console.example.comHubAlways. This is hub.hubExternalURL.
    auth.example.comDexUsing OIDC. This is idp.issuerURL and Dex’s config.issuer.
    kcp.example.comkcp front proxyUsing external kcp and giving users or edges direct kcp access.
    kcp-root.example.com, one per shardEach kcp shardUsing external kcp: shards advertise these as their virtual-workspace URLs.
    *.apps.example.comInfrastructure provider routesPublishing applications and App Studio previews.

    Keep each public hostname exactly one label below a zone whose wildcard certificate you hold. A hostname two labels down (console.dev.example.com) is not covered by a *.example.com certificate.

    Where to start

    Start with Install the hub . For a production deployment, read authentication , external kcp , and operations before onboarding users.