seabird-plugin-bundle

Requirements

• Rust 1.42+
• SQLite
• Protobuf

Settings

Settings can either be included as a part of the environment or in a .env file.

• SEABIRD_HOST - hostname of the seabird server
• SEABIRD_TOKEN - authentication token for the seabird server
• DATABASE_URL - SQLite connection string (e.g., sqlite://seabird.db)
• SEABIRD_ENABLED_PLUGINS - comma-separated list of enabled plugins - if empty, all plugins will be loaded
• SEABIRD_DISABLED_PLUGINS - comma-separated list of plugins that should not be enabled

Optional API Keys (required by specific plugins)

• OPENWEATHERMAP_API_KEY - required by the forecast plugin for weather data
• GOOGLE_MAPS_API_KEY - required by the forecast plugin for location lookups

Writing a new plugin

Unfortunately, writing a new plugin requires a few steps.

1. You must pick a unique name for your plugin. See supported_plugins in src/plugin.rs load() for the list of all existing plugin names.
2. You must create a new file in src/plugins that adheres to the Plugin async trait. See existing plugins in src/plugins for reference.
3. You must add your plugin to src/plugins/mod.rs. See existing entries in the file for reference.
4. You must add your unique plugin name to the supported_plugins Vec from step one.
5. You must load your plugin in src/plugin.rs load(). See existing entries for reference.

Building

cargo build

seabird-plugin-bundle will read DATABASE_URL at compile time to typecheck queries. If you see errors like relation "karma" does not exist, that means that migrations have had issues. The recommended fix is the following:

$ cargo install sqlx-cli
$ sqlx migrate run

Builds should succeed after this.