Type Alias: SshPluginConfig

SshPluginConfig = BasePluginConfig & SerializableSshPluginConfig & object

Configuration accepted by AppKitSshPlugin.

Pass a shared SshRuntime when the AppKit plugin and Mastra workspace resolver must use the same sessions, routes, ownership store, and reaper.

Type Declaration

runtime?

optional runtime?: SshRuntime

SshPluginConfig fields

Serializable AppKit SSH plugin configuration.

• auto (optional): Whether commands, services, and routes start a stopped machine before SSH use. Defaults to true; machine creation remains explicit.
• fallbackToServicePrincipal (optional): Whether a failed request-scoped OBO REST operation retries with the app service principal. Defaults to false.
• sandboxLifetimeSeconds (optional): Absolute service-managed Sandbox lifetime in seconds. Defaults to 86400 seconds and is recorded in Lakebase.
• reaperIntervalSeconds (optional): Interval between expiration scans in seconds. Defaults to 300 seconds; zero disables scheduled scans.
• routePrefix (optional): AppKit root path for remote web routes. Defaults to /sandbox.
• gatewayPort (optional): Databricks Sandbox SSH gateway port. Defaults to 2222.
• connectTimeoutMs (optional): SSH connection timeout in milliseconds. Defaults to 30000.
• commandTimeoutMs (optional): Default remote command timeout in milliseconds. Defaults to 120000.
• machineSoftware (optional): User-space software installed when a running Sandbox is first used. Defaults to mise; pass an empty array to disable setup.
• keyDirectory (optional): Optional server-side root directory for user-scoped SSH keys, fingerprints, and known-host files.