1
0
mirror of https://github.com/SuperBFG7/ympd synced 2024-11-05 06:16:16 +00:00
ympd/README.md
jcorporation f55fa51934 Replaces jquery.cookie.js with version from https://github.com/js-cookie/js-cookie
Added streamport option to commandline
Fixed description of options in manpage and help and README
Removed mpd host options from settings menu
Removed http stream options from settings menu
2018-05-24 18:50:05 +01:00

73 lines
2.5 KiB
Markdown

myMPD
====
myMPD is a lightweight MPD web client that runs without a dedicated webserver or interpreter.
It's tuned for minimal resource usage and requires only very litte dependencies.
myMPD is a fork of ympd.
This fork provides a reworked ui based on Bootstrap 4.
UI Components
-------------
- Bootstrap 4: https://getbootstrap.com/
- Bootstrap Notify: http://bootstrap-notify.remabledesigns.com/
- Bootstrap Slider: https://github.com/seiyria/bootstrap-slider
- Material Design Icons: https://material.io/tools/icons/?style=baseline
- Sammy.js: http://sammyjs.org/
- jQuery: https://jquery.com/
- js-cookie: https://github.com/js-cookie/js-cookie
Dependencies
------------
- libmpdclient 2: http://www.musicpd.org/libs/libmpdclient/
- cmake 2.6: http://cmake.org/
- OpenSSL: https://www.openssl.org/
Unix Build Instructions
-----------------------
1. install dependencies. cmake, libmpdclient (dev), and OpenSSL (dev) are available from all major distributions.
2. create build directory ```cd /path/to/src; mkdir build; cd build```
3. create makefile ```cmake .. -DCMAKE_INSTALL_PREFIX:PATH=/usr -DCMAKE_BUILD_TYPE=RELEASE```
4. build ```make```
5. install ```sudo make install``` or just run with ```./ympd```
6. Link your mpd music directory to ```/path/to/src/htdocs/library``` and put ```folder.jpg``` files in your album directories
Run flags
---------
```
Usage: ./mympd [OPTION]...
-D, --digest <htdigest> path to htdigest file for authorization
(realm mympd) [no authorization]
-h, --host <host> connect to mpd at host [localhost]
-p, --port <port> connect to mpd at port [6600]
-l, --localport <port> skip authorization for local port
-w, --webport [ip:]<port> listen interface/port for webserver [8080]
-s, --streamport <port> connect to mpd http stream at port [8000]
-u, --user <username> drop priviliges to user after socket bind
-m, --mpdpass <password> specifies the password to use when connecting to mpd
-V, --version get version
--help this help
```
SSL Support
-----------
To run ympd with SSL support:
- create a certificate (key and cert in the same file), example:
```
# openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -days 1000 -nodes
# cat key.pem cert.pem > ssl.pem
```
- tell ympd to use a webport using SSL and where to find the certificate:
```
# ./mympd -w "ssl://8081:/path/to/ssl.pem"
```
Copyright
---------
ympd: 2013-2014 <andy@ndyk.de>
myMPD: 2018 <mail@jcgames.de>