Skip to content

Commit b64287b

Browse files
authored
chore: hostHeaders default value is empty string (#5413)
pick from #5412 <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Updated plugin links to reflect the current repository addresses. - Improved clarity on host header behavior and configuration, including guidance for reverse proxy setups. - Enhanced textual explanations for properties related to host and protocol. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent 44cd620 commit b64287b

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

site/docs/basics/controller.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,7 @@ If user request exceeds the maximum length for parsing that we configured, the f
315315

316316
### Acquiring the Submitted Files
317317

318-
The `body` in the request can carry parameters as well as files. Generally speaking, our browsers always send files in `multipart/form-data`, and we now have two kinds of ways supporting submitting and acquiring files with the help of the framework's plugin [Multipart](https://github.com/eggjs/multipart).
318+
The `body` in the request can carry parameters as well as files. Generally speaking, our browsers always send files in `multipart/form-data`, and we now have two kinds of ways supporting submitting and acquiring files with the help of the framework's plugin [Multipart](https://github.com/eggjs/egg-multipart).
319319

320320
- #### `File` Mode:
321321
If you have no ideas about Nodejs's Stream at all, the `File` mode suits you well:
@@ -589,7 +589,7 @@ module.exports = {
589589

590590
**Notice:`fileExtensions` will be IGNORED when `whitelist` is overwritten.**
591591

592-
For more tech details about this, please refer [@eggjs/multipart](https://github.com/eggjs/multipart).
592+
For more tech details about this, please refer [Egg-Multipart](https://github.com/eggjs/egg-multipart).
593593

594594
### `header`
595595

@@ -605,9 +605,10 @@ Specially when we set `config.proxy = true` to deploy the application behind the
605605

606606
#### `ctx.host`
607607

608-
Reads the header's value configured by `config.hostHeaders` firstly, if fails, then it tries to get the value of host header, if fails again, it returns an empty string.
608+
Reads the header's value configured by `config.hostHeaders` firstly, if fails, then it tries to get the value of `host` header, if fails again, it returns an empty string.
609609

610-
`config.hostHeaders` defaults to `x-forwarded-host`.
610+
`config.hostHeaders` defaults to `''`.
611+
If the application is deployed behind a reverse proxy and `config.proxy = true` is configured, a correct value needs to be configured here, such as `x-forwarded-host`. Please configure it according to the actual value of the proxy.
611612

612613
#### `ctx.protocol`
613614

@@ -684,7 +685,7 @@ module.exports = {
684685

685686
By using Cookie, we can create an individual Session specific to every user to store user identity information, which will be encrypted then stored in Cookie to perform session persistence across requests.
686687

687-
The framework builds in [Session](https://github.com/eggjs/session) plugin, which provides `ctx.session` for us to get or set current user's Session.
688+
The framework builds in [Session](https://github.com/eggjs/egg-session) plugin, which provides `ctx.session` for us to get or set current user's Session.
688689

689690
```js
690691
class PostController extends Controller {

site/docs/basics/controller.zh-CN.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -598,7 +598,8 @@ module.exports = {
598598

599599
此 Getter 优先读取 `config.hostHeaders` 中配置的 header 值。若无法获取,则尝试读取 `host` 这个 header 的值。若仍旧获取不到,则返回空字符串。
600600

601-
`config.hostHeaders` 的默认配置为 `x-forwarded-host`
601+
`config.hostHeaders` 的默认配置为 `''` 空字符串。
602+
如果应用部署在反向代理后面,并且配置了 `config.proxy = true`,需要在这里配置一个正确的值,例如 `x-forwarded-host`,请按照代理真实值配置。
602603

603604
#### `ctx.protocol`
604605

0 commit comments

Comments
 (0)