1
0
mirror of https://github.com/SuperBFG7/ympd synced 2024-12-25 18:40:26 +00:00
ympd/README.md

69 lines
2.1 KiB
Markdown
Raw Normal View History

[![Build Status](https://travis-ci.org/notandy/ympd.svg)](https://travis-ci.org/notandy/ympd)
2014-01-17 19:03:08 +00:00
ympd
====
Standalone MPD Web GUI written in C, utilizing Websockets and Bootstrap/JS
2018-04-16 19:44:03 +00:00
This fork supports display of coverimages.
Link your mpd music directory to ```/path/to/src/htdocs/library``` and put ```folder.jpg``` files in your album directories
2014-03-11 19:29:39 +00:00
2014-01-17 19:03:08 +00:00
http://www.ympd.org
2014-03-08 20:11:14 +00:00
![ScreenShot](http://www.ympd.org/assets/ympd_github.png)
2014-01-17 19:03:08 +00:00
Dependencies
------------
- libmpdclient 2: http://www.musicpd.org/libs/libmpdclient/
- cmake 2.6: http://cmake.org/
- OpenSSL: https://www.openssl.org/
2014-01-17 19:03:08 +00:00
Unix Build Instructions
-----------------------
1. install dependencies. cmake, libmpdclient (dev), and OpenSSL (dev) are available from all major distributions.
2014-01-17 19:03:08 +00:00
2. create build directory ```cd /path/to/src; mkdir build; cd build```
3. create makefile ```cmake .. -DCMAKE_INSTALL_PREFIX:PATH=/usr -DWITH_DYNAMIC_ASSETS=ON -DCMAKE_BUILD_TYPE=RELEASE```
2014-01-17 19:03:08 +00:00
4. build ```make```
2014-03-08 20:11:14 +00:00
5. install ```sudo make install``` or just run with ```./ympd```
2014-01-17 19:03:08 +00:00
2014-03-18 00:37:33 +00:00
Run flags
---------
```
Usage: ./ympd [OPTION]...
-D, --digest <htdigest> path to htdigest file for authorization
(realm ympd) [no authorization]
-h, --host <host> connect to mpd at host [localhost]
-p, --port <port> connect to mpd at port [6600]
-w, --webport [ip:]<port> listen interface/port for webserver [8080]
-d, --dirbletoken <apitoken> Dirble API token
-u, --user <username> drop priviliges to user after socket bind
-V, --version get version
--help this help
2014-03-18 00:37:33 +00:00
```
2015-10-06 16:53:14 +00:00
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:
```
# ./ympd -w "ssl://8081:/path/to/ssl.pem"
```
2014-03-18 00:37:33 +00:00
2016-02-03 17:51:44 +00:00
Dirble support
--------------
1. Get an API-key from http://dirble.com
2. Add the key at ```var TOKEN = "";```, in ```mpd.js```.
2014-03-18 00:37:33 +00:00
2014-01-17 19:03:08 +00:00
Copyright
---------
2013-2014 <andy@ndyk.de>