Mirrors/koel
2
0
Fork 0
mirror of https://github.com/koel/koel synced 2024-11-10 06:34:14 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: improve streaming method docs

Browse source
This commit is contained in:
Phan An 2024-07-14 14:03:21 +02:00
parent 4a1786e6d4
commit 72973edfa4
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/usage/streaming.md
View file

@ -4,9 +4,9 @@
Koel supports three streaming methods which can be configured via the `STREAMING_METHOD` setting in `.env` file:
* `php`: Use native PHP `readfile()`. This is the default method, and the slowest and most unstable one.
* `x-accel-redirect`: Use nginx's [X-Accel](https://www.nginx.com/resources/wiki/start/topics/examples/x-accel/) module, designed for serving larger contents directly to the end user. Refer to [`nginx.conf.example`](https://github.com/koel/koel/blob/master/nginx.conf.example) for a sample nginx configuration file.
* `x-sendfile`: Use Apache's [mod_xsendfile](https://tn123.org/mod_xsendfile/) module. You'll need to install and configure the module manually. A sample configuration is as following:
* `php`: Uses native PHP file reading. This is the default method.
* `x-accel-redirect`: Only applicable if your webserver is nginx. Uses nginx's [X-Accel](https://www.nginx.com/resources/wiki/start/topics/examples/x-accel/) module, designed for serving larger contents directly to the end user. Refer to [`nginx.conf.example`](https://github.com/koel/koel/blob/master/nginx.conf.example) for a sample nginx configuration file.
* `x-sendfile`: Only applicable if your webserver is Apache (with or without a proxy server like nginx). Uses Apache's [mod_xsendfile](https://tn123.org/mod_xsendfile/) module. You'll need to install and configure the module manually. A sample configuration is as following:
```apache
LoadModule xsendfile_module libexec/apache2/mod_xsendfile.so
@ -17,12 +17,13 @@ Koel supports three streaming methods which can be configured via the `STREAMING
</IfModule>
```
Note that although its home page denotes "Apache2/Apache2.2," the module itself is known to work with later versions of Apache as well.
:::tip Tip
If you're using [Koel mobile app](https://koel.dev/#mobile) and can't play the songs, try switching the streaming method to `x-accel-redirect` or `x-sendfile` instead of `php`.
:::
:::warning Notice
`STREAMING_METHOD` doesn't have effects if you're transcoding or streaming from a cloud storage.
Koel always uses the native PHP method if you're transcoding or streaming from a cloud storage.
:::
## Transcoding FLAC