Skip to content

Commit a79a3d5

Browse files
authored
docs(advanced): powered by header (#344)
1 parent ba2912c commit a79a3d5

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# Powered By Header 🔋
6+
7+
By default, all Dart Frog responses include an `X-Powered-By` header:
8+
9+
```
10+
X-Powered-By: Dart with package:dart_frog
11+
```
12+
13+
:::info
14+
The `X-Powered-By` header is supported in `dart_frog >=0.1.2`
15+
:::
16+
17+
## Changing the `X-Powered-By` Header
18+
19+
The value of this header can be customized by specifying a custom `poweredByHeader` when calling `serve` from a [custom entrypoint](/docs/advanced/custom_entrypoint):
20+
21+
```dart
22+
import 'dart:io';
23+
24+
import 'package:dart_frog/dart_frog.dart';
25+
26+
Future<HttpServer> run(Handler handler, InternetAddress ip, int port) {
27+
return serve(handler, ip, port, poweredByHeader: 'Dart Frog');
28+
}
29+
```
30+
31+
With the above changes, all responses would include the following `X-Powered-By` header:
32+
33+
```
34+
X-Powered-By: Dart Frog
35+
```
36+
37+
## Removing the `X-Powered-By` Header
38+
39+
The `X-Powered-By` header can be removed by setting the value to `null`:
40+
41+
```dart
42+
import 'dart:io';
43+
44+
import 'package:dart_frog/dart_frog.dart';
45+
46+
Future<HttpServer> run(Handler handler, InternetAddress ip, int port) {
47+
return serve(handler, ip, port, poweredByHeader: null);
48+
}
49+
```

0 commit comments

Comments
 (0)