1
0
mirror of https://github.com/SuperBFG7/ympd synced 2024-11-17 03:04:47 +00:00
ympd/README.md
2018-07-30 23:28:31 +01:00

3.6 KiB

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 (https://github.com/notandy/ympd).

This fork provides a reworked ui based on Bootstrap 4, a modernized backend and many new features while having the same small footprint as ympd.

Design principles:

  • Keep it small and simple
  • Uses only mpd as source of truth
  • Mobile first UI
  • Keep security in mind

Featurelist:

  • Control mpd functions (play, pause, etc.)
  • Set mpd settings (repeat, random, etc.)
  • Browse mpd database by albumartist
  • Browse filesystem and playlists
  • Queue management
  • Playlist management
  • Advanced search
  • Progressiv Web App enabled
  • Local coverart support
  • HTTP stream support
  • Local playback of mpd http stream (html5 audio api)

myMPD is work in progress. Bugreportes and feature requests are very welcome.

Screenshots

image

UI Components

Backend

Dependencies

Build Dependencies

  • cmake 2.6
  • libasan3: for debug builds only
  • Java (openjdk-9-jre-headless): optional for minifying .css and .js files

Unix Build Instructions

  1. Install dependencies: cmake, libmpdclient (dev) and OpenSSL (dev), java are available from all major distributions.
  2. Build and install: cd /path/to/src; ./mkrelease.sh.
  3. Link your mpd music directory to /usr/share/mympd/htdocs/library and put folder.jpg files in your album directories (mkrelease.sh tries to do this for you).
  4. Configure your mpd with http stream output to use the local player.

Run Flags

Usage: ./mympd [OPTION]...

 -h, --mpdhost <host>          connect to mpd at host [localhost]
 -p, --mpdport <port>          connect to mpd at port [6600]
 -m, --mpdpass <password>      specifies the password to use when connecting to mpd
 -w, --webport <port>          listen port for webserver [80]
 -S, --ssl		       enable ssl
 -W, --sslport <port>	       listen port for ssl webserver [443]
 -C, --sslcert <filename>      filename for ssl certificate [/etc/mympd/ssl/server.pem]
 -K, --sslkey <filename>       filename for ssl key [/etc/mympd/ssl/server.key]
 -s, --streamport <port>       connect to mpd http stream at port [8000]
 -u, --user <username>         drop priviliges to user after socket bind
 -i, --coverimage <filename>   filename for coverimage [folder.jpg]
 -t, --statefile <filename>    filename for mympd state [/var/lib/mympd/mympd.state]
 -v, --version                 get version
 --help                        this help

SSL

  1. Create ca and certificate /path/to/src/contrib/crcert.sh (mkrelease.sh do this for you).
  2. Start myMPD with -S (use default certificate under /etc/mympd/ssl/).
  3. Import /etc/mympd/ssl/ca/ca.pem in your browser to trust the certificate.
  4. myMPD redirects http requests to https, ensure that myMPD hostname is resolvable.

ympd: 2013-2014 andy@ndyk.de

myMPD: 2018 mail@jcgames.de