Configuration & assets

Orbit configures itself lightly and lets the Panel instance carry brand and path. Assets are optional publishes. Full fluent surface: Panel configuration.

Provider defaults

When OrbitServiceProvider registers, it seeds config if missing:

{
    "path": "/orbit",
    "font": "Outfit",
    "brand": "Orbit",
}

Prefer setting these on the panel — that’s the source of truth for the shell:

Panel.make("admin")
    .path("orbit")
    .brand_name("Acme Admin")
    .font("Outfit")
    .primary("#f1511b")

There is no published config/orbit.py file. When you need app-wide knobs, set app.config["orbit"] = {…} before boot or extend the provider.

Orbit panel shell (light)

Orbit panel shell (dark)

Assets

Source	Published path	Shell URL
`orbit.css`	`public/vendor/orbit/orbit.css`	`/vendor/orbit/orbit.css`
`orbit.js`	`public/vendor/orbit/orbit.js`	`/vendor/orbit/orbit.js`

smith vendor:publish --tag=orbit-assets

orbit.js registers Alpine data for toasts, the database bell, live polling, SPA navigation, and action modals. After you change vendor files, republish or copy from the package so the panel shell picks them up.

Orbit published assets in the shell (light)

Orbit published assets in the shell (dark)

Prism directives

If Prism’s engine is bound, these directives are available:

@orbitStyles
@orbitScripts

They populate __orbit_styles and __orbit_scripts in the view context. The panel shell links the vendor URLs directly; use the directives when you embed Orbit chrome in your own layouts.

Middleware & auth

Panels default to the Almasix web middleware group (session, CSRF, cookies). Extra middleware appends:

panel.middleware(["auth"]).login().auth_guard("web")
# → ["web", "auth"]

Use .middleware([...], replace=True) only when you need to replace the whole stack. Orbit still gates guests via .login() — prefer not putting Almasix auth on the panel if you want the Orbit login page to stay reachable. Resource abilities still go through can_* helpers — see Resources.

SPA, billing, and notifications

These are panel methods, not separate config files:

Method	Docs
`.spa()` / `.spa_url_exceptions()`	Panel configuration — fetch-and-swap of `main.or-content`
`.tenant_billing(True)` / `.billing_provider(...)`	Multi-tenancy — `ManageBilling` + a `BillingProvider`
`.sqlite_notifications()` / `.live_broadcasts()`	Database and broadcast

PanelRegistry.get_by_path(...) and .get_by_domain(...) look up a registered panel when one app hosts several.

Scaffolding

smith make:orbit-resource Post --panel=admin
smith make:orbit-resource Post --panel=admin --model=Post --generate

The command writes app/orbit/{panel}/resources/post_resource.py. --generate reflects the model’s table columns into form fields and table columns. --force overwrites an existing file. See Resources overview.