Patrick Düggelin
12/13/2024, 11:35 AMMarvin
12/13/2024, 11:35 AMpyproject.toml
file for Prefect, you'll need to define it within the appropriate section. In Prefect 3.x, this typically involves specifying the URL under the ui_url
setting or using environment variables.
For Prefect 2.x and 3.x, you could specify the external proxy URL using PREFECT_UI_API_URL
or PREFECT_API_URL
as an environment variable. However, direct TOML configuration might look like specifying ui.api_url
under the respective heading.
Here's a quick breakdown based on the version:
- Prefect 2.x: Use the PREFECT_UI_API_URL
environment variable to set the URL externally if you're configuring it at runtime.
- Prefect 3.x: You can set the ui.api_url
in the prefect.toml
or similar configuration by specifying the external proxy URL, like <https://prefect-server.example.com/api>
.
For further details on Prefect 2.x, check this guide. For Prefect 3.x, you can look at the documentation.