Struct WebhookServer

pub struct WebhookServer { /* private fields */ }

A ready-to-use webhook server.

This server abstracts away lower-level details like TLS termination and other various configurations, validations or middlewares. The routes and their handlers are completely customizable by bringing your own Axum [Router].

For complete end-to-end implementations, see ConversionWebhookServer.

Implementations

impl WebhookServer

pub async fn new( router: Router, options: WebhookOptions, ) -> Result<(Self, Receiver<Certificate>)>

Creates a new ready-to-use webhook server.

The server listens on socket_addr which is provided via the WebhookOptions and handles routing based on the provided Axum router. Most of the time it is sufficient to use WebhookOptions::default(). See the documentation for WebhookOptions for more details on the default values.

To start the server, use the WebhookServer::run() function. This will run the server using the Tokio runtime until it is terminated.

Basic Example

use stackable_webhook::{WebhookServer, WebhookOptions};
use axum::Router;

let router = Router::new();
let (server, cert_rx) = WebhookServer::new(router, WebhookOptions::default())
    .await
    .expect("failed to create WebhookServer");

Example with Custom Options

use stackable_webhook::{WebhookServer, WebhookOptions};
use axum::Router;

let options = WebhookOptions::builder()
    .bind_address([127, 0, 0, 1], 8080)
    .add_subject_alterative_dns_name("my-san-entry")
    .build();

let router = Router::new();
let (server, cert_rx) = WebhookServer::new(router, options)
    .await
    .expect("failed to create WebhookServer");

pub async fn run(self) -> Result<()>

Runs the Webhook server and sets up signal handlers for shutting down.

This does not implement graceful shutdown of the underlying server.