Skip to content

Commit e4f25f1

Browse files
committed
docs updates
1 parent d512355 commit e4f25f1

File tree

3 files changed

+25
-12
lines changed

3 files changed

+25
-12
lines changed

.github/workflows/build.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,15 @@ on:
66
branches:
77
- master
88
paths-ignore:
9-
- 'docs/**'
9+
- README.md
10+
- docs/**
1011

1112
pull_request:
1213
branches:
1314
- master
1415
paths-ignore:
15-
- 'docs/**'
16+
- README.md
17+
- docs/**
1618

1719
jobs:
1820

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,20 @@ and [foobar2000](https://foobar2000.org/) music players.
1616

1717
### Browser support
1818
- Any recent browser should work
19-
- Due to high development effort required Internet Explorer of any version is not supported
2019

2120
### Downloads
2221
Check out [releases section](https://github.com/hyperblast/beefweb/releases).
2322

2423
### How to install
25-
#### DeaDBeeF
24+
25+
#### foobar2000
26+
27+
Open `foo_beefweb-*.fb2k-component` with foobar2000, you will be asked to install the plugin.
28+
29+
Alternatively open preferences window, select _Components_ section, click _Install..._ or _+_ , select downloaded `foo_beefweb-*.fb2k-component` file.
30+
31+
#### DeaDBeeF for Linux
32+
2633
Unpack `ddb_beefweb-*.tar.xz` to `$HOME/.local/lib/deadbeef`.
2734

2835
Alternatively if you use universal `deadbeef-static_*.deb` package you can install matching universal deb of beefweb:
@@ -31,14 +38,16 @@ Alternatively if you use universal `deadbeef-static_*.deb` package you can insta
3138
$ sudo dpkg -i deadbeef-beefweb_*.deb
3239
```
3340

34-
#### foobar2000
35-
Open `foo_beefweb-*.fb2k-component` with foobar2000, you will be asked to install the plugin.
41+
#### DeaDBeeF for macOS
42+
43+
Unpack `ddb_beefweb-*.zip` to `$HOME/Library/Application Support/Deadbeef/Plugins`.
3644

3745
### How to use
3846
Point your browser to `http://localhost:8880` and enjoy your web interface.
3947

40-
If you've enabled remote connections on plugin configuration screen
41-
you'll be able to connect from remote machines as well.
48+
If you enabled remote connections on plugin configuration screen
49+
you'll be able to connect from remote computer/phone as well.
50+
In this case IP address of computer where player is installed should be used instead of `localhost`.
4251

4352
To allow browsing and adding files via web interface
4453
specify music directories in plugin configuration screen.

docs/advanced-config.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@ The following configuration sources are considered when loading configuration (i
66

77
* Settings in UI
88
* `{player_profile_dir}/beefweb/config.json`
9-
- For foobar2000: `%APPDATA%\foobar2000-v2\beefweb\config.json`
10-
- For DeaDBeeF: `$XDG_CONFIG_HOME/deadbeef/beefweb/config.json` or `$HOME/.config/deadbeef/beefweb/config.json`
9+
- foobar2000 on Windows: `%APPDATA%\foobar2000-v2\beefweb\config.json`
10+
- foobar2000 on macOS: `$HOME/Library/foobar2000-v2/beefweb/config.json`
11+
- DeaDBeeF on Linux/*BSD: `$XDG_CONFIG_HOME/deadbeef/beefweb/config.json` or `$HOME/.config/deadbeef/beefweb/config.json`
12+
- DeaDBeeF on macOS: `$HOME/Library/Preferences/deadbeef/beefweb/config.json`
1113
* File specified by `BEEFWEB_CONFIG_FILE` environment variable (must be absolute)
1214

1315
If setting is specified in more preferred source it overrides values defined in less preferred.
@@ -16,15 +18,15 @@ All values are optional, you can specify only those you want to override.
1618

1719
The following options are available:
1820

19-
```json
21+
```js
2022
{
2123
"port": 8880,
2224
"allowRemote": true,
2325
"musicDirs": [],
2426
"authRequired": false,
2527
"authUser": "",
2628
"authPassword": "",
27-
"webRoot": "{directory of beefweb .dll or .so}/beefweb.root",
29+
"webRoot": ".../beefweb.root", // path inside installation directory, directory layout is different depending on OS/player
2830
"urlMappings": {},
2931
"responseHeaders": {},
3032
"clientConfigDir": "{player profile directory}/beefweb/clientconfig"

0 commit comments

Comments
 (0)