owen/lms
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added systemd integration, updated README

Browse Source
This commit is contained in:
emeric
2019-08-10 14:03:17 +02:00
parent 8ea1ed165e
commit 8b1eed504a
7 changed files with 104 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+73 -35
View File
@@ -1,6 +1,6 @@
# LMS - Lightweight Music Server
LMS is a self-hosted music streaming software: access your music collection from anywhere using a web interface!
_LMS_ is a self-hosted music streaming software: access your music collection from anywhere using a web interface!
A [demo](http://lms.demo.poupon.io) instance is available, with the following limitations:
- Settings cannot be saved
@@ -8,47 +8,58 @@ A [demo](http://lms.demo.poupon.io) instance is available, with the following li
- No administration panel
## Main features
- Low memory requirement (the demo instance runs on a Raspberry Pi3B+, using less than 10% of total memory even when transcoding)
- User management
- Recommendation engine
- Audio transcode for maximum interoperability and low bandwith requirements
- Persistent play queue across sessions
- Subsonic API
- Album artist
- Multi-value tags (artists, genres, ...)
- Custom tags (ex: "mood", "genre", "albummood", "albumgrouping", ...)
- MusicBrainzID support to handle duplicated artist and release names
- Playlists (only using Subsonic API for now)
- Starred Album/Artist/Tracks (only using Subsonic API for now)
* Low memory requirement (the demo instance runs on a Raspberry Pi3B+, using less than 10% of total memory even when transcoding)
* User management
* Recommendation engine
* Audio transcode for maximum interoperability and low bandwith requirements
* Persistent play queue across sessions
* Subsonic API
* Album artist
* Multi-value tags (artists, genres, ...)
* Custom tags (ex: _mood_, _genre_, _albummood_, _albumgrouping_, ...)
* MusicBrainzID support to handle duplicated artist and release names
* Playlists (only using Subsonic API for now)
* Starred Album/Artist/Tracks (only using Subsonic API for now)
* Systemd integration
## Recommendation engine
LMS provides several ways to help you find the music you like:
- Tag-based filters (ex: "Rock", "Metal" and "Aggressive", "Electronic" and "Relaxed", ...)
- Recommendations for similar artists and albums
- Radio mode
- Searches in album, artist and track names
- Most played/Recently added music
_LMS_ provides several ways to help you find the music you like:
* Tag-based filters (ex: _Rock_, _Metal_ and _Aggressive_, _Electronic_ and _Relaxed_, ...)
* Recommendations for similar artists and albums
* Radio mode
* Searches in album, artist and track names
* Most played/Recently added music
The recommendation engine makes use of [Self-Organizing Maps](https://en.wikipedia.org/wiki/Self-organizing_map).</br>
Please note this engine:
- may require some significant computation time on very large collections
- may require some significant computation time on large collections (ex: half a hour per 40k tracks)
- makes use of computed data available on [AcousticBrainz](https://acousticbrainz.org/). Therefore your music files must contain the [MusicBrainz Identifier](https://musicbrainz.org/doc/MusicBrainz_Identifier) for the recommendation engine to work properly (otherwise, only tag-based recommendations are provided)
## Subsonic API
The API version implemented is 1.12.0 and has been tested on Android using the official application, Ultrasonic and DSub.
The API version implemented is 1.12.0 and has been tested on Android using the official application, _Ultrasonic_ and _DSub_.
Since LMS uses metadata tags to organize data, a compatibility mode is used to navigate through the collection using the directory browsing commands.
Since _LMS_ uses metadata tags to organize music, a compatibility mode is used to navigate through the collection using the directory browsing commands.
The Subsonic API is enabled by default.
## Installation
Here are the required packages to build LMS on Debian Stretch:
This installation process and the default values of the configuration file and the systemd service file have been written for Debian Stretch.
Therefore, you may have to adapt commands and/or paths in order to fit to your distribution.
### Build dependencies
```sh
apt-get install g++ autoconf automake libboost-filesystem-dev libboost-system-dev libavcodec-dev libavutil-dev libavformat-dev libav-tools libmagick++-dev libpstreams-dev libconfig++-dev libpstreams-dev ffmpeg libtag1-dev
```
You also need wt4, that is not packaged yet on Debian. See [installation instructions](https://www.webtoolkit.eu/wt/doc/reference/html/InstallationUnix.html). You may need to build Wt4 in "Release" mode if you want to compile it natively on a Raspberry Pi3B+.
You also need wt4, that is not packaged yet on Debian. See [installation instructions](https://www.webtoolkit.eu/wt/doc/reference/html/InstallationUnix.html). Due to memory limitations, you may need to build _Wt4_ in _Release_ mode if you want to compile it natively on a Raspberry Pi3B+.
### Build
Get the latest stable release and build it this way:
```sh
git clone https://github.com/epoupon/lms.git lms
cd lms
@@ -62,23 +73,45 @@ configure will report any missing library.
```sh
make
```
Note: you can use `make -jN` to speed up compilation time (N is the number of compilation workers to spawn)
### Deployment
The following commands require root privileges.
```sh
make install
```
This command requires root privileges.
In order to customize the installation directories, you have to:
* use the following options of the `configure` script:
** --prefix (default to `/usr/local`)
** --sysconfigdir (/default to `/usr/local/etc`)
** --with-systemdunitdir (default to `/lib/systemd/system`)
* edit the `/etc/lms.conf` file
* edit the `/lib/systemd/system/lms.service` file
## Configuration
LMS uses a configuration file, installed in '/etc/lms.conf'. It is recommended to edit this file and change the relevant settings (working directory, listen port, etc.)
Create a dedicated lms system user:
```sh
useradd --system lms
```
Create working directories and give access to the _lms_ user:
```sh
mkdir /var/lms
touch /var/log/lms.log
touch /var/log/lms.access.log
chown lms:lms /var/lms /var/log/lms.log /var/log/lms.access.log
```
### Configuration
_LMS_ uses a configuration file, installed in '/etc/lms.conf'. It is recommended to edit this file and change relevant settings (listen address, listen port, working directory, Subsonic API activation, ...)
All other settings are set using the web interface.
It is highly recommended to run LMS as a non root user. Therefore make sure the user has write permissions on the working directory.
### Reverse proxy settings
_LMS_ is shipped with an embedded web server, but it is recommended to deploy behind a reverse proxy. You have to set the 'behind-reverse-proxy' option to 'true' in the configuration file.
## Reverse proxy settings
You have to set the 'behind-reverse-proxy' option to 'true' in the configuration file.
Here is an example to make LMS properly work on myserver.org using nginx.
Here is an example to make _LMS_ properly work on myserver.org using nginx.
```
server {
listen 80;
@@ -106,11 +139,16 @@ server {
## Running
```sh
lms [config_file]
service lms start
```
Logs are output in the working directory, in the files 'lms.log' and 'lms.access.log'.
Logs are output in `/var/log/lms.log` and `/var/log/lms.access.log`
To connect to LMS, just open your favorite browser and go to http://localhost:5082
To connect to _LMS_, just open your favorite browser and go to http://localhost:5082
To make _LMS_ run automatically during startup:
```sh
service lms enable
```
## Credits
- Wt (http://www.webtoolkit.eu/)