docs: clarify usage of frontend_url and BASE_PATH

I initially thought that `frontend_url` would control the prefix. The
docs on `BASE_PATH` weren't enough to get started, either.
This commit is contained in:
Colin Marc
2025-11-17 15:07:27 +01:00
parent 31a23dd781
commit e62f6d4511
4 changed files with 40 additions and 26 deletions

View File

@@ -8,7 +8,11 @@ centralized in this TOML file instead of environment variables.
- `frontend_url`
The URL the frontend will be accessed from. This is a required field and must include the trailing slash. The default
path is `http://localhost:8000/web/`. Make sure to change this to match your actual frontend URL.
path is `http://localhost:8000/web/`.
Make sure to change this to the URL you will use to access the application in your browser.
Note that this doesn't affect where the server binds, nor does it affect the base URL prefix. See the page on <a href="url-prefix.md"`>`BASE_PATH`</a> for information on how to configure a prefix.
- `cors_urls`
@@ -24,8 +28,8 @@ Here's a complete example of the general settings section in your `config.toml`:
```toml
[misc]
# REQUIRED: Change this to match your actual frontend URL
frontend_url = "http://localhost:8000/web/"
# REQUIRED: Change this to match your actual frontend domain.
frontend_url = "http://mediamanager.dev/"
cors_urls = ["http://localhost:8000"]
@@ -35,4 +39,4 @@ development = false
<note>
The <code>frontend_url</code> is the most important settings to configure correctly. Make sure it matches your actual deployment URLs.
</note>
</note>