Skip to content

Commit af50968

Browse files
coxdesentriz
andauthored
docs: uncomment WRTAG_PATH_FORMAT in Docker compose section (#195)
* docs: uncomment WRTAG_PATH_FORMAT in Docker section * upd --------- Co-authored-by: sentriz <senan@senan.xyz>
1 parent 4c385b4 commit af50968

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ The external API requires HTTP Basic authentication with `-web-api-key` as the p
178178
<summary><b>Examples with <i>cURL</i></b></summary>
179179

180180
```bash
181-
# Copy release from path, attempt to match and tag.
181+
# Copy release from path, attempt to match and tag.
182182
# Requires manual confirmation through the web UI if the match score is insufficient.
183183
curl \
184184
--request POST \
@@ -193,7 +193,7 @@ curl \
193193
--data-urlencode "confirm=true" \
194194
"https://:my-api-key@wrtag.hostname/op/reflink"
195195

196-
# Move release from path using a specific MBID.
196+
# Move release from path using a specific MBID.
197197
# Requires manual confirmation if the file match score is insufficient.
198198
curl \
199199
--request POST \
@@ -397,13 +397,13 @@ services:
397397
environment:
398398
# - PUID=1000 # optional user id for wrtag process
399399
# - PGID=1000 # optional group id for wrtag process
400-
- WRTAG_WEB_API_KEY= # change this
401-
- WRTAG_WEB_LISTEN_ADDR=:80
400+
- WRTAG_PATH_FORMAT= # required, see "Path format" docs section
401+
- WRTAG_WEB_API_KEY= # required
402+
- WRTAG_WEB_LISTEN_ADDR=:80 # required
402403
- WRTAG_WEB_PUBLIC_URL=https://wrtag.example.com
403404
- WRTAG_WEB_DB_PATH=/data/wrtag.db
404405
- WRTAG_LOG_LEVEL=debug
405-
# add more config options, like mentioned in "Global configuration" docs
406-
# - WRTAG_PATH_FORMAT=...
406+
# add more config options, like mentioned in "Global configuration" docs section
407407
# - WRTAG_ADDON=...,...
408408
# - WRTAG_RESEARCH_LINK=...,...
409409
# or, use the config file if you use wrtag outside the container. make sure to add it to `volumes:` too

0 commit comments

Comments
 (0)