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

chore(docs): some little doc improvements

Browse source
This commit is contained in:
Phan An 2024-03-23 11:06:14 +01:00
parent 1319cca84a
commit 233d55ddb5
2 changed files with 21 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/guide/what-is-koel.md
View file

@ -1,8 +1,10 @@
# What is Koel?
![Koel's homepage](../assets/img/home.webp)
A complete music streaming solution that hosts and streams your own music collection, Koel is designed to be:
<br>
# What is Koel?
A complete music streaming solution that hosts and streams your own music collection, Koel (also stylized as koel, with a lowercase k) is designed to be:
* **Modern and snappy** – Unlike some of our music, we’re not living in the 90s anymore. Koel looks and functions like a true modern application: clean, gorgeous, and fast. As a matter of fact, it won’t even work on prehistoric browsers.
* **Easy to set up** – Born from a personal frustration of failing to find something easy to install, Koel is dead-simple to get up and running, utilizing some of the most popular and proven technologies in the web development world: [Laravel](https://laravel.com), [Vue](https://vuejs.org), and [Docker](https://www.docker.com/).

22
docs/usage/music-discovery.md
View file

@ -1,15 +1,25 @@
# Music Discovery
There are several ways for Koel to discover your media files.
You can manually scan for songs, configure a watcher, host your files with Amazon S3, or upload files directly via the web interface.
There are several ways for Koel to discover your media files. In the most common scenario, you will have a directory on your server where you store your music files.
You can let Koel know where this directory is (the "media path") via the [web interface](#scan-via-the-web-interface) or the [CLI](../cli-commands#koel-storage-local).
:::danger Keep media out of Koel’s directory
Do NOT place your media files inside Koel’s directory. Though technically possible, doing so will make upgrading, downgrading, and reinstalling Koel much more tedious.
:::
Once the media path is set, you can scan for songs (either manually or [using a cron job](../cli-commands#command-scheduling)), configure a watcher, or upload files directly via the web interface.
:::tip Cloud Storage
With [Koel Plus](../plus/what-is-koel-plus), you can also use cloud storage services like Amazon S3 or Dropbox to store your media files. Refer to [Storage Support](../plus/storage-support) for more details.
:::
## Scan via the Web interface
:::warning Not for large libraries
Scanning via the web interface is vulnerable to HTTP timeouts, so if you have a decent-sized library, opt for other methods instead.
Scanning via the web interface is vulnerable to HTTP timeouts and memory limit, so if you have a decent-sized library, opt for other methods instead.
:::
Upload your songs into a readable directory on your server – preferably outside your web root dir – and configure Koel to scan and sync it by setting a "media path" under Manage → Settings.
Upload your songs into a readable directory on your server and configure Koel to scan and sync it by setting a "media path" under Manage → Settings.
![Settings Screen](../assets/img/settings.webp)
@ -46,7 +56,7 @@ A better approach is to use Laravel’s built-in scheduler. See [Command Schedul
## Upload via the Web Interface
You can upload songs directly as an admin by clicking the "Upload" sidebar menu item or just drag and drop files and folders into the web interface.
Note that if you’re not using a cloud storage (available with Koel Plus), you will need to set the media path first,
Note that if you’re not using a cloud storage (available with Koel Plus), you will need to set the media path first,
as the files will be uploaded into the `%media_path%/__KOEL__UPLOADS__` directory.
Depending on how big your files are, you may want to set `upload_max_filesize` and `post_max_size` in your `php.ini` correspondingly, or uploading may fail with a `Payload too large` error.
@ -114,7 +124,7 @@ Starting from version v3.0.0, Koel can work seamlessly with Amazon S3 with the h
### Supports and Requirements
As of current, only `mp3`, `ogg`, `m4a`, and `flac` files are supported.
As of current, only `mp3`, `ogg`, `m4a`, and `flac` files are supported.
### Step-by-Step Installation