Skip to content

Commit c07f52d

Browse files
authored
Update configuration options in README.md
1 parent dd1e9f8 commit c07f52d

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -88,13 +88,18 @@ bb --help
8888

8989
## Configuration File
9090

91-
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:
91+
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:
9292

9393
- **`host`**:
94-
Defines the IP address on which the service will run.
94+
Defines Bazarr's IP address.
9595

9696
- Default: `"0.0.0.0"`
9797

98+
- **`port`** (optional):
99+
Defines Bazarr's port. Can be omitted if Bazarr is accessible through ports 80 (HTTP) or 443 (HTTPS).
100+
101+
- Default: `"6767"` (You can change this to any available port on your server).
102+
98103
- **`protocol`**:
99104
Specifies the protocol to be used by the service (HTTP or HTTPS). **Note: Bazarr must be available using the specified protocol.**
100105

@@ -105,18 +110,12 @@ The [configuration file](./examples/config.json) contains various fields to set
105110

106111
- Replace `<YOUR_API_KEY>` with the actual Bazarr API key.
107112

108-
- **`port`** (optional):
109-
The port number on which Bazarr is accessible.
110-
111-
- Default: `"6767"` (You can change this to any available port on your server).
112-
113113
- **`baseUrl`** (optional):
114114
The [base URL](https://wiki.bazarr.media/Additional-Configuration/Settings/#url-base) or path at which the service will be accessible.
115115

116116
- Default: `""` (You can modify this based on your application's routing needs).
117117

118118
Example:
119-
120119
- `http://MY-IP:MY-PORT/` baseUrl should be an empty string or omitted.
121120
- `http://MY-IP:MY-PORT/bazarr/` - baseUrl should be `"bazarr"`.
122121

0 commit comments

Comments
 (0)