Doc for 1.1

This commit is contained in:
An Phan 2015-12-28 08:47:18 +07:00
parent 118210f8e3
commit e0e39c3b61
3 changed files with 74 additions and 1 deletions

View file

@ -4,4 +4,6 @@
**Koel** (also styled as **koel**, with a lowercase k) is a simple web-based personal audio streaming service written in [Vue](http://vuejs.org/) at the client side and [Laravel](http://laravel.com/) on server side. Targeting web developers, Koel embraces some of the more modern web technologies flexbox, audio and drag-and-drop API to name a few to do its job.
For system requirements, installation guides, as well as other documentation, head over to [Wiki](https://github.com/phanan/koel/wiki).
For system requirements, installation guides, and troubleshooting, head over to [Wiki](https://github.com/phanan/koel/wiki).
For upgrade guides, check out the `doc` folder.

View file

@ -0,0 +1,68 @@
# 1.0.0-beta or whatever there to 1.1.0
### Change Log
Koel 1.1 comes with lots of changes, most of them are (hopefully) improvements:
* Integration with Last.fm
* Better mobile experience
* Support for nginx X-Accel-Redirect added
* Support for AAC added (experimental)
* Streaming method configuration is now explicit
* Various bug fixes, optimizations, and enhancements
### Steps to Upgrade
#### 0. Back up
Back up your installation of Koel, including application files and database dump. Verify it. And verify it again.
#### 1. Get the latest code
``` bash
git fetch --all
git checkout v1.1.0
```
#### 2. Upgrade Laravel, install packages, and migrate database
Laravel has been updated from 5.1 to 5.2 to make use of some new awesome features. To adapt the changes, run the following commands:
``` bash
composer install
php artisan migrate --force
```
#### 3. Compile Koels client
``` bash
npm update
NODE_ENV=production
gulp --production
```
#### 4. Integrate with Last.fm (Optional)
Starting from 1.1, Koel can be configured to integrate with Last.fm and retrieve interesting information about the current playing song artist bio, album cover and track listing, track interaction and scrobbling etc. In order to start using these functionalities, just [create a Last.fm API account](http://www.last.fm/api/account/create) and fill the credentials into `.env`, namely these two variables:
```
LASTFM_API_KEY=
LASTFM_API_SECRET=
```
Afterwards you can connect your Last.fm account with Koel from the Profile page.
#### 5. Set your streaming method (Optional)
The first version of Koel automatically detects the availability of `mod_xsendfile` module and prefers it over native PHPs `sendfile` for streaming. To prevent possible problems originating from Apache configuration errors, this behavior has been removed. You will now need to explicitly set a streaming method in `.env` file for any other than `php`:
```
# The streaming method.
# Can be either 'php' (default), 'x-sendfile', or 'x-accel-redirect'
# See https://github.com/phanan/koel/wiki#streaming-music for more information.
STREAMING_METHOD=php
```
### Things went south?
Just restore the previous installation from the backup volume created in step 0. You completed the step, did you not? Did you not?

3
doc/update/README.md Normal file
View file

@ -0,0 +1,3 @@
# Upgrade Koel
Every new version of Koel should come with an upgrade guide just pick the one applicable for you and follow the steps closely.