From 944ba1542ae36c735682aa2dc2af0448a9448f6e Mon Sep 17 00:00:00 2001 From: Martyn Date: Sat, 15 Aug 2026 10:25:19 +0100 Subject: [PATCH] Fixes additional inaccuracies in log level documentation AI-Tool: Claude Code --- website/docs/02-getting-started.md | 35 ++++++++++++++++++++---------- website/docs/03-overview.md | 35 ++++++++++++++++++++---------- website/docs/10-configuration.md | 7 +++--- website/docs/11-deploying.md | 4 ++-- 4 files changed, 53 insertions(+), 28 deletions(-) diff --git a/website/docs/02-getting-started.md b/website/docs/02-getting-started.md index c2d3127e..77fab585 100644 --- a/website/docs/02-getting-started.md +++ b/website/docs/02-getting-started.md @@ -65,19 +65,32 @@ Compile and run the program with `cargo run`. You should see the following: ```sh > cargo run -🔧 Configured for debug. - >> address: 127.0.0.1 - >> port: 8000 +🔧 config (profile: debug) + >> http2: true + >> log_level: INFO + >> log_format: Pretty + >> cli_colors: auto >> workers: [..] - >> keep-alive: 5s + >> max_blocking: 512 + >> ident: Rocket + >> ip_header: X-Real-IP >> limits: [..] - >> tls: disabled - >> temp dir: /tmp - >> log level: normal - >> cli colors: true -🛰 Routes: - >> (index) GET / -🚀 Rocket has launched from http://127.0.0.1:8000 + >> temp_dir: /tmp + >> keep_alive: 5 + >> shutdown.ctrlc: true + >> shutdown.signals: {"SIGTERM"} + >> shutdown.grace: 2 + >> shutdown.mercy: 3 + >> shutdown.force: true +📬 routes (count: 1) + >> route: -9 GET / (index src/main.rs:3) +📦 fairings (count: 1) + >> fairing: Shield liftoff, response, singleton +🛡️ shield (policies: 3) + >> header: X-Content-Type-Options: nosniff + >> header: X-Frame-Options: SAMEORIGIN + >> header: Permissions-Policy: interest-cohort=() +🚀 Rocket has launched on http://127.0.0.1:8000 ``` Visit `http://localhost:8000` to see your first rkt application in action! diff --git a/website/docs/03-overview.md b/website/docs/03-overview.md index 1ced4669..564c3610 100644 --- a/website/docs/03-overview.md +++ b/website/docs/03-overview.md @@ -171,19 +171,32 @@ Running the application, the console shows: ```sh > cargo run -🔧 Configured for debug. - >> address: 127.0.0.1 - >> port: 8000 +🔧 config (profile: debug) + >> http2: true + >> log_level: INFO + >> log_format: Pretty + >> cli_colors: auto >> workers: [..] - >> keep-alive: 5s + >> max_blocking: 512 + >> ident: Rocket + >> ip_header: X-Real-IP >> limits: [..] - >> tls: disabled - >> temp dir: /tmp - >> log level: normal - >> cli colors: true -🛰 Routes: - >> (world) GET /hello/world -🚀 Rocket has launched from http://127.0.0.1:8000 + >> temp_dir: /tmp + >> keep_alive: 5 + >> shutdown.ctrlc: true + >> shutdown.signals: {"SIGTERM"} + >> shutdown.grace: 2 + >> shutdown.mercy: 3 + >> shutdown.force: true +📬 routes (count: 1) + >> route: -9 GET /hello/world (world src/main.rs:3) +📦 fairings (count: 1) + >> fairing: Shield liftoff, response, singleton +🛡️ shield (policies: 3) + >> header: X-Content-Type-Options: nosniff + >> header: X-Frame-Options: SAMEORIGIN + >> header: Permissions-Policy: interest-cohort=() +🚀 Rocket has launched on http://127.0.0.1:8000 ``` :::tip[`#[launch]` infers the return type!] diff --git a/website/docs/10-configuration.md b/website/docs/10-configuration.md index 842a1fcc..efd0580a 100644 --- a/website/docs/10-configuration.md +++ b/website/docs/10-configuration.md @@ -361,12 +361,11 @@ The `tls.mutual` parameter is expected to be a dictionary that deserializes into [`MtlsConfig`]: https://docs.rs/rkt/latest/rkt/mtls/struct.MtlsConfig.html [`mtls`]: https://docs.rs/rkt/latest/rkt/mtls/index.html -Rocket reports if TLS and/or mTLS are enabled at launch time: +Rocket reports if TLS and/or mTLS are enabled as part of the endpoint it +announces at launch time: ```text -🔧 Configured for debug. - ... - >> tls: enabled w/mtls +🚀 Rocket has launched on https://127.0.0.1:8000 (TCP + mTLS) ``` Once mutual TLS is properly enabled, the [`mtls::Certificate`] request guard can diff --git a/website/docs/11-deploying.md b/website/docs/11-deploying.md index b8cab702..4b8e5abc 100644 --- a/website/docs/11-deploying.md +++ b/website/docs/11-deploying.md @@ -335,8 +335,8 @@ environment, we provide only the following general guidelines: * **Enable debug logging if the application misbehaves.** - The default log level in `--release` (the release profile) is `critical`. + The default log level in `--release` (the release profile) is `error`. This level may omit messages helpful in understanding application - misbehavior. To reenable those messages, set `ROCKET_LOG_LEVEL=debug`. + misbehavior. To enable those messages, set `ROCKET_LOG_LEVEL=debug`. [configuration profile]: ./configuration/#profiles