Skip to content

Commit 13e7426

Browse files
committed
docs: update README.md
1 parent a886564 commit 13e7426

File tree

1 file changed

+31
-3
lines changed

1 file changed

+31
-3
lines changed

README.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,19 @@ services:
8181
- DB_PASSWORD=my_password
8282
- DB_DATABASE=my_database
8383
- DB_HOSTNAME=postgresql
84+
85+
# Initialise admin account
8486
8587
- SETUP_ADMIN_NAME=admin
8688
- SETUP_ADMIN_PASSWORD=passwordpassword # min length 12
89+
90+
# Radarr integration
91+
- RADARR_BASE_URL=radarr:7878
92+
- RADARR_API_KEY=someApiKey
93+
94+
# Sonarr integration
95+
- SONARR_BASE_URL=sonarr:8989
96+
- SONARR_API_KEY=someApiKey
8797
depends_on:
8898
postgresql:
8999
condition: service_healthy
@@ -113,7 +123,7 @@ volumes:
113123
```
114124
This is so `Midarr` has the same reference to your media library as your integrations, and can serve them.
115125

116-
#### Setup
126+
#### Initialise admin account
117127

118128
An admin account will be initialised for you on server startup, provided you have these `environment` variables configured:
119129

@@ -125,6 +135,24 @@ environment:
125135
```
126136
Login with these credentials, and access the `Settings` page to configure your server.
127137

138+
#### Radarr integration
139+
140+
```yaml
141+
environment:
142+
- RADARR_BASE_URL=radarr:7878
143+
- RADARR_API_KEY=someApiKey
144+
```
145+
Provide these environment variables to integrate your Radarr instance.
146+
147+
#### Sonarr integration
148+
149+
```yaml
150+
environment:
151+
- SONARR_BASE_URL=sonarr:8989
152+
- SONARR_API_KEY=someApiKey
153+
```
154+
Provide these environment variables to integrate your Sonarr instance.
155+
128156
## Video support
129157

130158
* Video H.264
@@ -133,13 +161,13 @@ Login with these credentials, and access the `Settings` page to configure your s
133161

134162
## Contributing
135163

136-
Thank you for your contributions! Big or small - we welcome all!
164+
Thank you for all your contributions! Big or small - all is welcome!
137165

138166
## License
139167

140168
`Midarr` is open-sourced software licensed under the [MIT license](LICENSE).
141169

142-
## Screenshots
170+
## Preview
143171

144172
![Preview](docs/online.png)
145173
![Preview](docs/series.png)

0 commit comments

Comments
 (0)