serverext

package
v0.2.17 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 27, 2026 License: MPL-2.0 Imports: 1 Imported by: 0

Documentation

Overview

Package serverext is the chassis seam for overlay-supplied HTTP routes on the admin server. It mirrors the clicmd / bgservice registry idiom: an overlay self-registers route mounters from its init() and the product binary activates them with a blank import. Open core registers none, so a self-hosted chassis exposes no extra surface and behaves identically.

The seam is deliberately generic — no billing/quota/transport vocabulary. It knows only two mount points, matching the admin server's two relevant routers:

  • Public: the raw mux, BEFORE the auth middleware. For endpoints that authenticate themselves (e.g. a webhook verified by a third-party signature). gorilla/mux matches in registration order and the auth subrouter is a "/" catch-all, so public mounters MUST run before it.
  • Tenant: the /v1/tenants/{tenant} subrouter, AFTER the auth + tenant resolver middleware. Handlers read auth.FromContext for the resolved slug/id and the caller's per-tenant capabilities, exactly like the built-in tenant-scoped handlers.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RegisterPublic

func RegisterPublic(m RouterMounter)

RegisterPublic adds a mounter for the raw (unauthenticated) mux. Called from a backend package's init(); the product binary activates it with a blank import.

func RegisterTenant

func RegisterTenant(m RouterMounter)

RegisterTenant adds a mounter for the /v1/tenants/{tenant} subrouter (auth + tenant resolver already applied). Called from a backend package's init().

Types

type RouterMounter

type RouterMounter func(r *mux.Router)

RouterMounter registers overlay routes onto an admin-server router.

func PublicMounters

func PublicMounters() []RouterMounter

PublicMounters returns the registered public mounters, in registration order.

func TenantMounters

func TenantMounters() []RouterMounter

TenantMounters returns the registered tenant-scoped mounters, in registration order.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL