Updated documentation

This commit is contained in:
emeric
2015-03-04 12:55:20 +01:00
parent 7eba050af3
commit f1189d2154
3 changed files with 27 additions and 9 deletions
+13 -7
View File
@@ -1,22 +1,22 @@
LMS - Lightweight Media Server
LMS is a free media streaming software, released under the GPLv3 license.
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
- Audio/Video transcode for maximum interoperability and low bandwith requirements
- User management
- Fast "Winamp-style" interface
- Audio/Video transcode (including downsampling), based on the libav project (see https://www.libav.org/).
- Custom API to access data using Protocol Buffers format over TCP/SSL (see https://github.com/google/protobuf/ and src/remote/proto)
- API available in Protocol Buffers (see src/remote/proto/messages.proto)
Please note LMS is still under development and will gain more features in the future.
An android application is being developped as well.
A mobile application based on Kivy is being developped as well.
LMS is written entirely in C++. Therefore, it is suitable to run on embedded devices, where space and/or memory are limited.
Please note some media files may require significant CPU usage to be transcoded.
I) DEPENCIES
I) DEPENDENCIES
Debian packages:
g++ autoconf automake libboost-dev libavcodec-dev libwtdbosqlite-dev libwthttp-dev libwtdbo-dev libwt-dev libprotobuf-dev libconfig++-dev libprotobuf-dev protobuf-compiler libjpeg8-dev libavcodec-dev libavformat-dev libavutil-dev
@@ -37,7 +37,7 @@ II) BUILD
III) Setting up SSL materials (required by the SSL server and the web server)
This is just an example, you could do whatever you want (ca, self signed cert, etc.)
This is just a self signed certificate example, you could do use a CA if you want.
Generate a dh file:
# openssl dhparam -out dh2048.pem 2048
@@ -57,3 +57,9 @@ Create the lms.conf file using the etc/lms.sample.conf
Depending on your SSL parameters, you may be asked for the PEM passphrase to unlock the private key.
V) LINKS
- Wt (http://www.webtoolkit.eu/)
- bootstrap3 (http://getbootstrap.com/)
- libav project (https://www.libav.org/).
- Protocol Buffers (https://github.com/google/protobuf/)