Skip to content

Commit c7cec23

Browse files
committed
chore: update README.md and refine proxy_filter warning msg
1 parent 3e9f840 commit c7cec23

File tree

3 files changed

+10
-6
lines changed

3 files changed

+10
-6
lines changed

.github/pull_request_template.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
<!-- copy from: https://github.com/encode/starlette/blob/master/.github/pull_request_template.md -->
2-
31
<!-- Thanks for contributing 💚
42
Given this is a project maintained by volunteers, please read this template to not waste your time, or ours! 😁 -->
53

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ So, it perfectly supports all features of [httpx.AsyncClient](https://www.python
6363
> visit our `CHANGELOG.md` for more info.
6464
6565
```shell
66-
pip install fastapi-proxy-lib
66+
pip install fastapi-proxy-lib[standard]
6767
```
6868

6969
Perhaps you've noticed that we're installing `fastapi-proxy-lib[standard]` instead of `fastapi-proxy-lib`. The difference is:
@@ -108,6 +108,10 @@ English is not the native language of the author (me), so if you find any areas
108108

109109
If you think this project helpful, consider giving it a star ![GitHub Repo stars](https://img.shields.io/github/stars/wsh032/fastapi-proxy-lib?style=social), which makes me happy. :smile:
110110

111+
## Refers
112+
113+
[Can fastapi proxy another site as a response to the request?](https://github.com/tiangolo/fastapi/discussions/7382)
114+
111115
## License
112116

113117
This project is licensed under the terms of the *Apache License 2.0*.
@@ -119,7 +123,7 @@ This project is licensed under the terms of the *Apache License 2.0*.
119123
[CI: lint-test#link]: https://github.com/WSH032/fastapi-proxy-lib/actions/workflows/lint-test.yml
120124
[CI: docs]: https://github.com/WSH032/fastapi-proxy-lib/actions/workflows/docs.yml/badge.svg?branch=main
121125
[CI: docs#link]: https://github.com/WSH032/fastapi-proxy-lib/actions/workflows/docs.yml
122-
[CI: publish]: https://github.com/WSH032/fastapi-proxy-lib/actions/workflows/publish.yml/badge.svg?branch=main
126+
[CI: publish]: https://github.com/WSH032/fastapi-proxy-lib/actions/workflows/publish.yml/badge.svg
123127
[CI: publish#link]: https://github.com/WSH032/fastapi-proxy-lib/actions/workflows/publish.yml
124128
[pre-commit.ci status]: https://results.pre-commit.ci/badge/github/WSH032/fastapi-proxy-lib/main.svg
125129
[pre-commit.ci status#link]: https://results.pre-commit.ci/latest/github/WSH032/fastapi-proxy-lib/main

src/fastapi_proxy_lib/core/_tool.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -419,11 +419,13 @@ def warn_for_none_filter(
419419
if proxy_filter is None:
420420
msg = dedent(
421421
"""\
422-
The proxy filter is None, which means no filter will be used.
423-
This is not recommended, because it may cause security issues.
422+
The `proxy_filter` is None, which means no filter will be used.
423+
It is not recommended, because it may cause security issues.
424424
425425
A default proxy filter will be used, which will reject the proxy request:
426426
- if the host of url is ip address, and is not global ip address.
427+
428+
More info: https://wsh032.github.io/fastapi-proxy-lib/Usage/Security/
427429
"""
428430
)
429431
warnings.warn(msg, stacklevel=3)

0 commit comments

Comments
 (0)