From c07f52d30edcf95b5fb5090cc4ef04da30b705d6 Mon Sep 17 00:00:00 2001 From: Mateo Radman <48420316+mateoradman@users.noreply.github.com> Date: Thu, 3 Oct 2024 14:43:16 +0200 Subject: [PATCH] Update configuration options in README.md --- README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index ea8a889..ff8a372 100644 --- a/README.md +++ b/README.md @@ -88,13 +88,18 @@ bb --help ## Configuration File -The [configuration file](./examples/config.json) contains various fields to set up and run the service. Below is a breakdown of each field and its purpose: +The [configuration file](./examples/config.json) contains various fields to set up and communicate with Bazarr. Below is a breakdown of each field and its purpose: - **`host`**: - Defines the IP address on which the service will run. + Defines Bazarr's IP address. - Default: `"0.0.0.0"` +- **`port`** (optional): + Defines Bazarr's port. Can be omitted if Bazarr is accessible through ports 80 (HTTP) or 443 (HTTPS). + + - Default: `"6767"` (You can change this to any available port on your server). + - **`protocol`**: Specifies the protocol to be used by the service (HTTP or HTTPS). **Note: Bazarr must be available using the specified protocol.** @@ -105,18 +110,12 @@ The [configuration file](./examples/config.json) contains various fields to set - Replace `` with the actual Bazarr API key. -- **`port`** (optional): - The port number on which Bazarr is accessible. - - - Default: `"6767"` (You can change this to any available port on your server). - - **`baseUrl`** (optional): The [base URL](https://wiki.bazarr.media/Additional-Configuration/Settings/#url-base) or path at which the service will be accessible. - Default: `""` (You can modify this based on your application's routing needs). Example: - - `http://MY-IP:MY-PORT/` baseUrl should be an empty string or omitted. - `http://MY-IP:MY-PORT/bazarr/` - baseUrl should be `"bazarr"`.