MatrixTransportConfig

Defined in: types.ts:187

Matrix application-service transport. The CLI binds the AS HTTP listener to port (defaults to 9099 for co-located/community-box mode). Must match the port in the registration YAML’s url (read by the homeserver, not by Zooid).

Properties

type

type: "matrix"

Defined in: types.ts:188

---

homeserver

homeserver: string

Defined in: types.ts:189

---

as_token

as_token: string

Defined in: types.ts:194

Application-service token. Sent on every Client-Server API call.

Default

value of $MATRIX_AS_TOKEN in the daemon’s env

---

hs_token

hs_token: string

Defined in: types.ts:199

Homeserver-to-AS token. The homeserver presents this on push.

Default

value of $MATRIX_HS_TOKEN in the daemon’s env

---

sender_localpart

sender_localpart: string

Defined in: types.ts:204

Localpart of the AS sender user (the bridge bot).

Default

‘zooid’, or the workstation name when workstation is set

---

user_namespace

user_namespace: string

Defined in: types.ts:209

Regex covering all bot users, e.g. @.*:example.com.

Default

@.*:<host>, or workstation-scoped @<workstation>\..*:<host> when workstation is set

---

port?

optional port?: number

Defined in: types.ts:215

AS HTTP listener port. Mutually exclusive with advertise_url. When set, the registration url is http://host.docker.internal:<port>.

Default

9099 (co-located mode) when neither port nor advertise_url is set

---

advertise_url?

optional advertise_url?: string

Defined in: types.ts:221

Explicit registration URL advertised to the homeserver. Mutually exclusive with port. Use for multi-workstation setups where the homeserver reaches the daemon via a stable external address.

---

mode?

optional mode?: "appservice" | "client"

Defined in: types.ts:227

AS mode. appservice = push transport (homeserver calls the daemon). client = pull transport (daemon polls /_matrix/client/v3/sync).

Default

'appservice'

---

workstation?

optional workstation?: string

Defined in: types.ts:233

Workstation identity derived from the top-level workstation: in zooid.yaml. Present only when a workstation is declared; absent for the shared-namespace zooid dev profile.

---

space?

optional space?: string

Defined in: types.ts:238

Workforce space localpart. Resolves to alias #<space>:<server>.

Default

'dev'