diff --git a/Writerside/mm.tree b/Writerside/mm.tree index 46b62ae..c7cae75 100644 --- a/Writerside/mm.tree +++ b/Writerside/mm.tree @@ -11,7 +11,6 @@ - @@ -20,6 +19,7 @@ + diff --git a/Writerside/redirection-rules.xml b/Writerside/redirection-rules.xml index 89f0254..c6fb40a 100644 --- a/Writerside/redirection-rules.xml +++ b/Writerside/redirection-rules.xml @@ -30,4 +30,8 @@ Created after removal of "MetadataRelay" from MediaManager MetadataRelay.html + + Created after removal of "Frontend" from MediaManager + configuration-frontend.html + \ No newline at end of file diff --git a/Writerside/topics/Base-Path.md b/Writerside/topics/Base-Path.md new file mode 100644 index 0000000..5ee4882 --- /dev/null +++ b/Writerside/topics/Base-Path.md @@ -0,0 +1,20 @@ +# Base Path + +Unfortunately you need to build the docker container, to configure a url base path. This is because +SvelteKit needs to know the base path at build time. + +## Docker Build Arguments + +When building the Docker image for the frontend, you can pass build arguments to set the base path and version. + +### `BASE_PATH` + +Sets the base url path, it must begin with a slash and not end with one. Example (in build command): +- clone the repo +- cd into the repo's root directory +- `docker build --build-arg BASE_URL=/media -f Dockerfile .` + +### `VERSION` + +Sets the version variable in the container. This isn't strictly necessary, but it can be useful for debugging or versioning purposes. +Example: `docker build --build-arg VERSION=locally-built -f web/Dockerfile .` \ No newline at end of file diff --git a/Writerside/topics/configuration-backend.md b/Writerside/topics/configuration-backend.md index 9341537..7e2939e 100644 --- a/Writerside/topics/configuration-backend.md +++ b/Writerside/topics/configuration-backend.md @@ -1,20 +1,19 @@ # Backend -These settings configure the core backend application through the `config.toml` file. All backend configuration is now centralized in this TOML file instead of environment variables. + +These settings configure the core backend application through the `config.toml` file. All backend configuration is now +centralized in this TOML file instead of environment variables. ## General Settings (`[misc]`) - `frontend_url` -The URL the frontend will be accessed from. This is a required field and must include the trailing slash. +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. - `cors_urls` A list of origins you are going to access the API from. Note the lack of trailing slashes. -- `api_base_path` - -The URL base path of the backend API. Default is `/api/v1`. Note the lack of a trailing slash. - - `development` Set to `true` to enable development mode. Default is `false`. @@ -26,13 +25,10 @@ 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:3000/" +frontend_url = "http://localhost:8000/web/" # REQUIRED: List all origins that will access the API -cors_urls = ["http://localhost:3000", "http://localhost:8000"] - -# Optional: API base path (rarely needs to be changed) -api_base_path = "/api/v1" +cors_urls = ["http://localhost:8000"] # Optional: Development mode (set to true for debugging) development = false @@ -40,4 +36,4 @@ development = false The frontend_url and cors_urls are the most important settings to configure correctly. Make sure they match your actual deployment URLs. - + \ No newline at end of file diff --git a/Writerside/topics/configuration-frontend.md b/Writerside/topics/configuration-frontend.md deleted file mode 100644 index 95c088b..0000000 --- a/Writerside/topics/configuration-frontend.md +++ /dev/null @@ -1,27 +0,0 @@ -# Frontend - -## Environment Variables - -### `PUBLIC_API_URL` - -You (the browser) must reach the backend from this url. Default is `http://localhost:8000/api/v1`. Example: -`https://mediamanager.example.com/api/v1`. - -## Build Arguments (web/Dockerfile) - -**TODO: expand on this section** - -Unfortunately you need to build the frontend docker container, to configure a url base path for the frontend. This is because -SvelteKit needs to know the base path at build time. - -### `BASE_URL` - -Sets the base url path, it must begin with a slash and not end with one. Example (in build command): -- clone the repo -- cd into the repo's root directory -- `docker build --build-arg BASE_URL=/media -f web/Dockerfile .` - -### `VERSION` - -Sets the `PUBLIC_VERSION` environment variable at runtime in the frontend container. Passed during build. Example (in -build command): `docker build --build-arg VERSION=1.2.3 -f web/Dockerfile .` \ No newline at end of file diff --git a/Writerside/topics/configuration-overview.md b/Writerside/topics/configuration-overview.md index 03c3803..0f9b686 100644 --- a/Writerside/topics/configuration-overview.md +++ b/Writerside/topics/configuration-overview.md @@ -11,11 +11,11 @@ The recommended way to install and run Media Manager is using Docker and Docker ## Setup * Download the `docker-compose.yaml` and `config.toml` from the MediaManager repo with the following command: - ``` + ```sh wget -O docker-compose.yaml https://raw.githubusercontent.com/maxdorninger/MediaManager/refs/heads/master/docker-compose.yaml - wget -O docker-compose.yaml https://raw.githubusercontent.com/maxdorninger/MediaManager/refs/heads/master/config.toml - # you probably need to edit the config.toml file, for more help see the documentation - docker compose up -d + wget -O config.toml https://raw.githubusercontent.com/maxdorninger/MediaManager/refs/heads/master/config.toml + # you probably need to edit the config.toml file, for more help see the documentation + docker compose up -d ``` * For more information on the available configuration options, see the [Configuration section](Configuration.md) of the diff --git a/Writerside/topics/developer-guide.md b/Writerside/topics/developer-guide.md index a702da9..18daa59 100644 --- a/Writerside/topics/developer-guide.md +++ b/Writerside/topics/developer-guide.md @@ -8,7 +8,6 @@ This section is for those who want to contribute to Media Manager or understand - `web/`: Frontend SvelteKit application - `Writerside/`: Documentation - `metadata_relay/`: Metadata relay service -- ### Backend Development @@ -21,6 +20,14 @@ This section is for those who want to contribute to Media Manager or understand - Uses `npm` for package management - SvelteKit with TypeScript +### Further Configuration + +#### Env Variables + +- `BASE_PATH`: this sets the base path for the app +- `PUBLIC_VERSION`: this sets the version variable +- `FRONTEND_FILES_DIR`: directory for frontend files, e.g. in Docker container it is `/app/web/build` + ### Contributing - Consider opening an issue to discuss significant changes before starting work