Expand description
A drop-in replacement for apalis-board: HTTP surface, live updates, and the
apalis-tui dashboard.
This crate mounts a JSON API for apalis job queues on an axum or actix-web server, streams
live task and log events over SSE, and serves a ratatui dashboard compiled to WebAssembly
from the bundle it carries. The wire contract matches apalis-board-api 1.0.0-rc.8 route for
route, and the extra routes on top of it (capabilities, actions, typed status events) are
additive. Repository and full documentation:
https://github.com/ngriaznov/apalis-rtui.
Swap one line in Cargo.toml:
apalis-board = { package = "apalis-rtui", version = "0.1.0-rc.1", features = ["axum"] }and every path a consumer already writes against apalis-board keeps working:
apalis_board::axum::framework::{ApiBuilder, RegisterRoute},
apalis_board::axum::sse::{TracingBroadcaster, TracingSubscriber},
apalis_board::axum::ui::ServeUI, apalis_board::axum::push_task, and the rest of the
framework-agnostic handler set. apalis-rtui mirrors that exact module shape under its own
name: axum and actix are each the whole ported API surface, re-exported under a
per-framework namespace, gated by the matching Cargo feature.
See the crate README for the full drop-in story and feature table.
Modulesยง
- actix
- The actix-web HTTP surface:
ApiBuilder,RegisterRoute, the framework-agnostic handler set, live-update SSE types (eventsfeature), andServeUI(uifeature). - axum
- The axum HTTP surface:
ApiBuilder,RegisterRoute, the framework-agnostic handler set, live-update SSE types (eventsfeature), andServeUI(uifeature).