Options for creating a bot.
identifier: string
The internal identifier of the bot. Since it is used for the actor URI, it should not be changed after the bot is federated.
If omitted, "bot" will be used.
class: Service | Application
The type of the bot actor. It should be either Service or Application.
If omitted, Service will be used.
The username of the bot. It will be a part of the fediverse handle. It can be changed after the bot is federated.
The display name of the bot. It can be changed after the bot is federated.
summary: Text<"block", TContextData>
The description of the bot. It can be changed after the bot is federated.
The avatar URL of the bot. It can be changed after the bot is federated.
The header image URL of the bot. It can be changed after the bot is federated.
properties: Record<string, Text<"block" | "inline", TContextData>>
The custom properties of the bot. It can be changed after the bot is federated.
followerPolicy: "accept"
| "reject"
| "manual"
How to handle incoming follow requests. Note that this behavior can be overridden by manually invoking FollowRequest.accept or FollowRequest.reject in the Bot.onFollow event handler.
"accept"(default): Automatically accept all incoming follow requests."reject": Automatically reject all incoming follow requests."manual": Require manual handling of incoming follow requests.
repository: Repository
The underlying repository to use for storing data. If omitted, KvRepository will be used.
queue: MessageQueue
The underlying message queue to use for handling incoming and outgoing activities. If omitted, incoming activities are processed immediately, and outgoing activities are sent immediately.
The software information of the bot. If omitted, the NodeInfo protocol will be unimplemented.
behindProxy: boolean
Whether to trust X-Forwarded-* headers. If your bot application is
behind an L7 reverse proxy, turn it on.
Turned off by default.
pages: PagesOptions
The options for the web pages of the bot. If omitted, the default options will be used.