Skip to content

Commit

Permalink
docs: mention host/port config+deps within readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mgoltzsche committed Feb 21, 2024
1 parent f6698c2 commit 3039f31
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ This allows serve the beets web UI, a Subsonic API as well as the generated M3U
python3 -m pip install beets-webrouter
```

To install the plugins that are used by the example configuration below, run:
```sh
python3 -m pip install beets-beetstream beets-webm3u
```

## Configuration

Enable the plugin and add a `webrouter` section to your beets `config.yaml` as follows:
Expand All @@ -23,6 +28,8 @@ plugins:
- smartplaylist

webrouter:
host: 127.0.0.1
port: 8337
routes:
/:
plugin: web
Expand Down Expand Up @@ -56,7 +63,7 @@ Once the `webrouter` plugin is enabled within your beets configuration, you can
beet webrouter
```

Once the server started, you can browse [`http://localhost:8337`](http://localhost:8337).
You browse the server at [`http://localhost:8337`](http://localhost:8337).

### CLI

Expand Down
2 changes: 1 addition & 1 deletion beetsplug/webrouter/config_default.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
host: "127.0.0.1"
host: 127.0.0.1
port: 8337
cors: ""
cors_supports_credentials: false
Expand Down

0 comments on commit 3039f31

Please sign in to comment.