Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 24 additions & 11 deletions website/docs/02-getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down
35 changes: 24 additions & 11 deletions website/docs/03-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!]
Expand Down
7 changes: 3 additions & 4 deletions website/docs/10-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions website/docs/11-deploying.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Loading