[DOC] updated README
This commit is contained in:
@@ -4,9 +4,11 @@ LMS is a self-hosted media streaming software, released under the GPLv3 license.
|
||||
It allows you to access your music and your videos using an https web interface.
|
||||
|
||||
## Features
|
||||
- Winamp-like interface, suited for large databases
|
||||
- Winamp-like interface, suited for large media collections
|
||||
- Audio/Video transcode for maximum interoperability and low bandwith requirements
|
||||
- User management
|
||||
- Multi genre
|
||||
- MusicBrainzID support
|
||||
|
||||
Please note LMS is still under development and will gain more features in the future.
|
||||
|
||||
@@ -42,13 +44,15 @@ $ make install
|
||||
This command requires root privileges
|
||||
|
||||
## Running
|
||||
|
||||
Here is a command line example to run on port 5081:
|
||||
```sh
|
||||
$ /usr/bin/lms --docroot='/usr/share/lms/docroot/;/resources,/css,/images' --approot=/usr/share/lms/approot --http-address 0.0.0.0 --http-port 5081
|
||||
```
|
||||
It is highly recommended to run LMS as a non root user.
|
||||
The exectuable needs write accesses to the /var/lms/ directory.
|
||||
|
||||
To connect to LMS, just open your favorite browser and go to http://localhost:5081
|
||||
|
||||
## Mobile
|
||||
|
||||
Add the following code in your wt_config.xml file:
|
||||
@@ -69,12 +73,14 @@ Generate a self signed certificate:
|
||||
```sh
|
||||
$ openssl req -x509 -out cert.pem -keyout privkey.pem -newkey rsa:4096
|
||||
```
|
||||
Run:
|
||||
Run (on port 5081):
|
||||
```sh
|
||||
$ /usr/bin/lms --docroot='/usr/share/lms/docroot/;/resources,/css,/images' --approot=/usr/share/lms/approot --https-address 0.0.0.0 --https-port 5081 --ssl-certificate cert.pem --ssl-private-key privkey.pem --ssl-tmp-dh dh2048.pem
|
||||
```
|
||||
Depending on your SSL parameters, you may be asked for the PEM passphrase to unlock the private key.
|
||||
|
||||
To connect to LMS, just open your favorite browser and go to https://localhost:5081
|
||||
|
||||
## Credits
|
||||
|
||||
- Wt (http://www.webtoolkit.eu/)
|
||||
|
||||
Reference in New Issue
Block a user