Skip to content

Commit ca66622

Browse files
committed
update readme
1 parent 6ea7a7a commit ca66622

File tree

1 file changed

+7
-15
lines changed

1 file changed

+7
-15
lines changed

README.md

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,9 @@
1-
# xplay
1+
# xplay-compatible
22

3-
A simple media server that searches multimedia files from a directory, parses their metadata, generates xspf playlist as index and serves audio/video over http/https.
4-
5-
Supported file formats: mp3, flac, ogg, mp4, mkv. Metadata parsing currently does not support mkv.
3+
This branch is an alternative version of xplay. Compared with the main branch, this branch is compatible with a wider range of media players (like potplayer), but does not have basic authentication feature.
64

75
[![This program produces valid XSPF playlist files.](assets/valid-xspf.png)](https://validator.xspf.org/referrer/)
86

9-
This program:
10-
11-
- Traverses directories recursively by default. Can be disabled by `--no-recursive` option
12-
- Does not follow symbolic links found in directories
13-
- Excludes files starting with a period (hidden files in linux)
14-
157
## Usage
168

179
Start http media server with `/play.xspf` as index:
@@ -28,17 +20,17 @@ Use `-w` to generate and save xspf to file and exit. `-b` and `-p` options will
2820

2921
Metadata parsing can become slow when handling a large number of multimedia files. Use `--no-tag` option to disable metadata/tag parsing if you do not need metadata in xspf playlists.
3022

31-
To secure the media server, activate https with `--ssl-cert` `--ssl-key` and set up http basic authentication with `--password`. Default username "xplay" can be changed via `--username`:
23+
To secure the media server, activate https with `--ssl-cert` `--ssl-key` and restrict host header by setting expected server hostnames in `--allowed-hosts`:
3224

3325
```bash
34-
./xplay -b $bind_ipaddr -p $bind_port -d ./music\
35-
--username $username --password $password\
36-
--ssl-cert $cert_path --ssl-key $certkey_path
26+
./xplay -b 0.0.0.0 -p 8443 -d ./music\
27+
--ssl-cert example.com.crt --ssl-key example.com.pem\
28+
--allowed-hosts example.com,www.example.com,127.0.0.1
3729
```
3830

3931
## Client
4032

41-
Media players with http and xspf support (like VLC) can be used as clients.
33+
Media players with http and xspf support (like VLC) can be used as clients. Tested with potplayer, Clementine, audacious...
4234

4335
```bash
4436
vlc http://$ip:$port/play.xspf

0 commit comments

Comments
 (0)