Eugene E. Kashpureff Jr
9 years ago
parent
73fedc1132
commit
4d160db69b
@ -1,2 +1 @@ |
||||
.idea |
||||
target |
||||
target/ |
||||
|
||||
@ -0,0 +1,6 @@ |
||||
Guidelines for Contributing |
||||
--------------------------- |
||||
|
||||
Libresonic currently does **NOT** diverge substantially from the original [Subsonic](http://subsonic.org). Please visit Issue #40 on Github for more details about the Rebrand process before continuing. |
||||
|
||||
Until the Rebrand has finished Issues and Pull Requests will most likely not be accepted or put on hold. Please check back later once the Rebrand has been completed. |
||||
@ -0,0 +1,67 @@ |
||||
<!-- |
||||
# INSTALL.md |
||||
# Libresonic/libresonic |
||||
--> |
||||
Requirements |
||||
------------ |
||||
|
||||
* Recent version of [Maven](http://maven.apache.org/). |
||||
* A JDK installation. 1.7.x series of OpenJDK or Oracle JDK 7+ should work. |
||||
* Optional: lintian and fakeroot, for .deb package |
||||
* Test as follows: |
||||
|
||||
``` |
||||
$ which mvn |
||||
/usr/local/bin/mvn |
||||
$ echo $JAVA_HOME |
||||
/usr/lib/jvm/java-1.7.0-openjdk.x86_64 |
||||
$ |
||||
``` |
||||
|
||||
Now you can clone a copy of this repository and switch to the `release` branch if it is not automatically checked out: |
||||
|
||||
``` |
||||
$ git clone git://github.com/Libresonic/libresonic.git |
||||
$ cd libresonic |
||||
$ git checkout release |
||||
$ |
||||
``` |
||||
|
||||
Standalone WAR |
||||
-------------- |
||||
|
||||
At this point you are ready to build the basic Subsonic WAR. This is required for all the other build targets, so you should do it before proceeding. |
||||
|
||||
``` |
||||
$ mvn package |
||||
<lots of buildspam> |
||||
[INFO] Building war: /path/to/repo/subsonic/subsonic-main/target/subsonic.war |
||||
<more buildspam> |
||||
$ |
||||
``` |
||||
|
||||
Tomcat Installation |
||||
------------------- |
||||
|
||||
The WAR may be copied directly to a Tomcat server's webapps/ directory and deployed. |
||||
|
||||
``` |
||||
$ cp subsonic-main/target/subsonic.war /var/lib/tomcat6/webapps/ |
||||
$ |
||||
``` |
||||
|
||||
|
||||
Packaged .deb |
||||
------------- |
||||
|
||||
You can furthermore go ahead to create a .deb suitable for installation on Debian or Ubuntu. These instructions should similarly work with rpm(for RedHat/CentOS or Fedora), but it is has not been tested. |
||||
|
||||
``` |
||||
$ mvn -P full -pl subsonic-booter -am install |
||||
$ mvn -P full -pl subsonic-installer-debian/ -am install |
||||
$ sudo dpkg -i ./subsonic-installer-debian/target/subsonic-*.deb |
||||
$ |
||||
``` |
||||
|
||||
Good luck! |
||||
|
||||
@ -0,0 +1 @@ |
||||
CONTRIBUTING.md |
||||
@ -0,0 +1 @@ |
||||
CONTRIBUTING.md |
||||
@ -1,13 +1,43 @@ |
||||
# Subsonic |
||||
Subsonic is a web-based media streamer, providing ubiquitous access to your music and video collection. |
||||
<!-- |
||||
# README.md |
||||
# Libresonic/libresonic |
||||
--> |
||||
Libresonic |
||||
======== |
||||
|
||||
More than 20 apps are available for Android, iPhone, Windows Phone, Sonos etc. |
||||
What is Libresonic? |
||||
----------------- |
||||
|
||||
Supports virtually all media formats, converting files on the fly. |
||||
Libresonic is a free, web-based media streamer, providing ubiqutious access to your music. Use it to share your music with friends, or to listen to your own music while at work. You can stream to multiple players simultaneously, for instance to one player in your kitchen and another in your living room. |
||||
|
||||
Also includes a Podcast receiver and jukebox feature allowing you to control what's playing on your computer from your mobile phone. |
||||
Libresonic is designed to handle very large music collections (hundreds of gigabytes). Although optimized for MP3 streaming, it works for any audio or video format that can stream over HTTP, for instance AAC and OGG. By using transcoder plug-ins, Libresonic supports on-the-fly conversion and streaming of virtually any audio format, including WMA, FLAC, APE, Musepack, WavPack and Shorten. |
||||
|
||||
Please see subsonic.org for more details. |
||||
If you have constrained bandwidth, you may set an upper limit for the bitrate of the music streams. Libresonic will then automatically resample the music to a suitable bitrate. |
||||
|
||||
### Note |
||||
This source code is for Subsonic 5.3, which is the last version of Subsonic released with an open source license. |
||||
In addition to being a streaming media server, Libresonic works very well as a local jukebox. The intuitive web interface, as well as search and index facilities, are optimized for efficient browsing through large media libraries. Libresonic also comes with an integrated Podcast receiver, with many of the same features as you find in iTunes. |
||||
|
||||
Based on Java technology, Libresonic runs on most platforms, including Windows, Mac, Linux and Unix variants. |
||||
|
||||
|
||||
History |
||||
----- |
||||
|
||||
The original [Subsonic](http://www.subsonic.org/) is developed by [Sindre Mehus](mailto:sindre@activeobjects.no). Subsonic was open source through version 6.0-beta1, and closed-source from then onwards. |
||||
|
||||
Libresonic is maintained by [Eugene E. Kashpureff Jr](mailto:eugene@kashpureff.org). It originated as an unofficial("Kang") of Subsonic which did not contain the Licensing code checks present in the official builds. With the announcement of Subsonic's closed-source future, a decision was made to make a full fork and rebrand to Libresonic. |
||||
|
||||
Libresonic will strive to maintain compatibility and stability for Subsonic users, including a clean upgrade path. New features and refactoring are welcomed as a Pull Request on Github. |
||||
|
||||
|
||||
License |
||||
------- |
||||
|
||||
Libresonic is free software and licensed under the [GNU General Public License version 3](http://www.gnu.org/copyleft/gpl.html). The code in this repository(and associated binaries) are free of any "license key" or other restrictions. If you wish to thank the maintainer of this repository, please consider a donation to the [Electronic Frontier Foundation](https://supporters.eff.org/donate). |
||||
|
||||
The original Subsonic was released under the GPLv3 through version 5.3. Beginning with 6.0, the software is only available under a commercial license. There is a [Subsonic Premium](http://www.subsonic.org/pages/premium.jsp) package which offers extra functionality. Subsonic also offers RPM, Deb, Exe, and other pre-built packages that Libresonic does not. |
||||
|
||||
|
||||
Usage |
||||
----- |
||||
|
||||
A WAR compiled from the latest tag is provided on the [Releases page](https://github.com/Libresonic/libresonic/releases). This can be installed as a Tomcat or compatible webapp, and should "just work". Please see the [INSTALL document](https://github.com/Libresonic/libresonic/blob/release/INSTALL.md) for instructions on building from source. |
||||
|
||||
Loading…
Reference in new issue