From 4887b9c716ceb9519b446477fe3cb827a135e058 Mon Sep 17 00:00:00 2001 From: Pamela Fox Date: Fri, 1 Dec 2023 10:01:26 -0800 Subject: [PATCH 1/4] Add tips on relative url_for in templates docs --- docs/en/docs/advanced/templates.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/en/docs/advanced/templates.md b/docs/en/docs/advanced/templates.md index 38618aeeb..6ca9fd5a6 100644 --- a/docs/en/docs/advanced/templates.md +++ b/docs/en/docs/advanced/templates.md @@ -72,6 +72,17 @@ In this example, it would link to a CSS file at `static/styles.css` with: And because you are using `StaticFiles`, that CSS file would be served automatically by your **FastAPI** application at the URL `/static/styles.css`. +!!! note + The url generated by `url_for` is a full absolute URL, including the protocol. That may not work in a reverse proxy situation, like Traefik or GitHub Codespaces. + If you would instead like it to generate relative URLs, you can override the `url_for` template function in your Python code: + + ```python + templates.env.globals["url_for"] = app.url_path_for + ``` + + Another way to affect the generated URLs is to customize `uvicorn` with arguments like `proxy-headers`, `root-path`, and `forwarded-allow-ips`. + See uvicorn's docs on settings. + ## More details For more details, including how to test templates, check Starlette's docs on templates. From 389da15b4209de03592f130061ba5d544934c847 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Fri, 1 Dec 2023 18:02:51 +0000 Subject: [PATCH 2/4] =?UTF-8?q?=F0=9F=8E=A8=20[pre-commit.ci]=20Auto=20for?= =?UTF-8?q?mat=20from=20pre-commit.com=20hooks?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/en/docs/advanced/templates.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/docs/advanced/templates.md b/docs/en/docs/advanced/templates.md index 6ca9fd5a6..293117107 100644 --- a/docs/en/docs/advanced/templates.md +++ b/docs/en/docs/advanced/templates.md @@ -82,7 +82,7 @@ And because you are using `StaticFiles`, that CSS file would be served automatic Another way to affect the generated URLs is to customize `uvicorn` with arguments like `proxy-headers`, `root-path`, and `forwarded-allow-ips`. See uvicorn's docs on settings. - + ## More details For more details, including how to test templates, check Starlette's docs on templates. From 4e92266c2d5fc250677e16214fa32b1d3106cba2 Mon Sep 17 00:00:00 2001 From: Pamela Fox Date: Fri, 1 Dec 2023 10:19:11 -0800 Subject: [PATCH 3/4] Fix indentation for note block --- docs/en/docs/advanced/templates.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/en/docs/advanced/templates.md b/docs/en/docs/advanced/templates.md index 293117107..8aeef906a 100644 --- a/docs/en/docs/advanced/templates.md +++ b/docs/en/docs/advanced/templates.md @@ -73,15 +73,15 @@ In this example, it would link to a CSS file at `static/styles.css` with: And because you are using `StaticFiles`, that CSS file would be served automatically by your **FastAPI** application at the URL `/static/styles.css`. !!! note - The url generated by `url_for` is a full absolute URL, including the protocol. That may not work in a reverse proxy situation, like Traefik or GitHub Codespaces. - If you would instead like it to generate relative URLs, you can override the `url_for` template function in your Python code: + The url generated by `url_for` is a full absolute URL, including the protocol. That may not work in a reverse proxy situation, like Traefik or GitHub Codespaces. + If you would instead like it to generate relative URLs, you can override the `url_for` template function in your Python code: - ```python - templates.env.globals["url_for"] = app.url_path_for - ``` + ```python + templates.env.globals["url_for"] = app.url_path_for + ``` - Another way to affect the generated URLs is to customize `uvicorn` with arguments like `proxy-headers`, `root-path`, and `forwarded-allow-ips`. - See uvicorn's docs on settings. + Another way to affect the generated URLs is to customize `uvicorn` with arguments like `proxy-headers`, `root-path`, and `forwarded-allow-ips`. + See uvicorn's docs on settings. ## More details From 59349af9c4f4bcc143f4626999f37512732cc69a Mon Sep 17 00:00:00 2001 From: Pamela Fox Date: Fri, 1 Dec 2023 10:20:05 -0800 Subject: [PATCH 4/4] Fix indent again --- docs/en/docs/advanced/templates.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/en/docs/advanced/templates.md b/docs/en/docs/advanced/templates.md index 8aeef906a..d65efb691 100644 --- a/docs/en/docs/advanced/templates.md +++ b/docs/en/docs/advanced/templates.md @@ -76,12 +76,12 @@ And because you are using `StaticFiles`, that CSS file would be served automatic The url generated by `url_for` is a full absolute URL, including the protocol. That may not work in a reverse proxy situation, like Traefik or GitHub Codespaces. If you would instead like it to generate relative URLs, you can override the `url_for` template function in your Python code: - ```python - templates.env.globals["url_for"] = app.url_path_for - ``` + ```python + templates.env.globals["url_for"] = app.url_path_for + ``` - Another way to affect the generated URLs is to customize `uvicorn` with arguments like `proxy-headers`, `root-path`, and `forwarded-allow-ips`. - See uvicorn's docs on settings. + Another way to affect the generated URLs is to customize `uvicorn` with arguments like `proxy-headers`, `root-path`, and `forwarded-allow-ips`. + See uvicorn's docs on settings. ## More details