Skip to content

Commit caddffb

Browse files
committed
docs: Mention background cert rotation
1 parent f1fee5d commit caddffb

File tree

1 file changed

+4
-0
lines changed
  • crates/stackable-webhook/src/tls

1 file changed

+4
-0
lines changed

crates/stackable-webhook/src/tls/mod.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ pub enum TlsServerError {
5555

5656
/// A server which terminates TLS connections and allows clients to communicate
5757
/// via HTTPS with the underlying HTTP router.
58+
///
59+
/// It also rotates the generated certificates as needed.
5860
pub struct TlsServer {
5961
config: ServerConfig,
6062
cert_resolver: Arc<CertificateResolver>,
@@ -99,6 +101,8 @@ impl TlsServer {
99101
/// bound socket address. It only accepts TLS connections. Internally each
100102
/// TLS stream get handled by a Hyper service, which in turn is an Axum
101103
/// router.
104+
///
105+
/// It also starts a background task to rotate the certificate as needed.
102106
pub async fn run(self) -> Result<()> {
103107
let certificate_rotation_loop =
104108
tokio::spawn(async { Self::run_certificate_rotation_loop(self.cert_resolver).await });

0 commit comments

Comments
 (0)