mirror of
https://github.com/koel/koel
synced 2024-11-24 05:03:05 +00:00
chore(docs): some little doc improvements
This commit is contained in:
Phan An
parent
98a5c89b4c
commit
1cb89b3a5f
5 changed files with 19 additions and 19 deletions
|
|
@ -72,7 +72,7 @@ export default defineConfig({
|
|||
items: [
|
||||
{ text: 'What is Koel Plus?', link: '/plus/what-is-koel-plus' },
|
||||
{ text: 'Purchase & Activation', link: '/plus/purchase-activation' },
|
||||
{ text: 'Storage Support', link: '/plus/storage-support' },
|
||||
{ text: 'Cloud Storage Support', link: '/plus/cloud-storage-support' },
|
||||
{ text: 'Collaboration', link: '/plus/collaboration' },
|
||||
{ text: 'Single Sign-On', link: '/plus/sso' },
|
||||
]
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Storage Support
|
||||
# Cloud Storage Support
|
||||
|
||||
In addition to storing your music on the same server as Koel’s installation via the `local` storage driver,
|
||||
In addition to storing your music on the same server as Koel’s installation via the `local` storage driver,
|
||||
Koel Plus offers several different file storage options, including Amazon S3, S3-compatible services, Dropbox, and likely more in the future.
|
||||
This page will guide you through the process of setting up these storage options.
|
||||
|
||||
|
|
@ -77,7 +77,7 @@ AWS_BUCKET=koel
|
|||
|
||||
### Cloudflare R2
|
||||
|
||||
[Cloudflare R2](https://www.cloudflare.com/developer-platform/r2/) is yet another excellent choice for an S3-compatible service.
|
||||
[Cloudflare R2](https://www.cloudflare.com/developer-platform/r2/) is yet another excellent choice for an S3-compatible service.
|
||||
The setup is pretty much similar to the above:
|
||||
|
||||
<CaptionedImage :src="r2CreateBucket" alt="Create CF R2 bucket screen">Create a Cloudflare R2 bucket</CaptionedImage>
|
||||
|
|
@ -105,10 +105,10 @@ Koel Plus also supports using Dropbox as a storage driver, although the setup is
|
|||
<CaptionedImage :src="dropboxAppSettings" alt="Dropbox app permissions">Set sufficient app permissions</CaptionedImage>
|
||||
2. Under your Dropbox app's Settings tab, make a note of the "App key" and "App secret" values. Now, from the root folder of your Koel installation, run the following command:
|
||||
```bash
|
||||
php artisan koel:storage:dropbox
|
||||
php artisan koel:storage:dropbox
|
||||
```
|
||||
You'll be prompted to enter the "App key" and "App secret" values obtained earlier.
|
||||
3. Koel will generate a URL for you to visit and authorize the Dropbox app. Afterward, you'll receive an access code.
|
||||
3. Koel will generate a URL for you to visit and authorize the Dropbox app. Afterward, you'll receive an access code.
|
||||
4. Enter the access code back into the command line's prompt. Koel will then finalize the setup automatically and start using Dropbox as its storage.
|
||||
|
||||
Now when you upload music files to Koel, they'll be stored in your Dropbox app's folder.
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
# Single Sign-On
|
||||
|
||||
Apart from the default authentication mechanism with email and password, users can also log in to Koel Plus via Single Sign-On (SSO).
|
||||
The only supported SSO provider as of current is Google, with more to come in the future.
|
||||
As of current, the only supported SSO provider is Google, with more to come in the future.
|
||||
|
||||
## Google
|
||||
|
||||
|
|
@ -33,9 +33,9 @@ Clicking on the Google button will open a new window where you can log in with y
|
|||
## User Management
|
||||
|
||||
When a user logs in via SSO for the first time, a new user account will be created in Koel with the email address, name, avatar, and the SSO ID obtained from the SSO provider.
|
||||
If, however, there's already an existing user with the same email address , Koel will merge the two accounts with a sensible strategy.
|
||||
If, however, there's already an existing user with the same email address , Koel will merge the two accounts with a sensible merging strategy.
|
||||
|
||||
SSO users can update their name and avatar, but not their email address. Also, a new user created via SSO will not have a password set, and will not be able to log in via the email+password method.
|
||||
SSO users can update their name and avatar, but not their email address. Furthermore, a new user created via SSO does not have a password set and won't be able to log in via the email+password method.
|
||||
|
||||
<script lang="ts" setup>
|
||||
import googleOauth from '../assets/img/plus/google-oauth.webp'
|
||||
|
|
|
|||
|
|
@ -3,23 +3,23 @@
|
|||
## Introduction
|
||||
|
||||
Koel Plus is the premium version of Koel. It offers additional features and enhancements on top of the Community edition, including but not limited to:
|
||||
|
||||
|
||||
- **Multi-library Support**: In Koel Plus, each user has their own library, which they populate by uploading their own music.
|
||||
- **Music Sharing**: By default, uploaded music is private to the user who uploaded it. However, users can choose to share their music with others by marking songs as public.
|
||||
- **Collaboration**: Users can invite others to [collaborate](./collaboration) on their playlists, allowing them to add, remove, and reorder songs.
|
||||
- **Cloud Storage Support**: In addition to local storage, Koel Plus supports cloud storage services like Amazon S3 (or any S3-compatible service) and Dropbox. See [Storage Support](./storage-support) for more information.
|
||||
- **[Collaboration](./collaboration)**: Users can invite others to collaborate on their playlists, allowing them to add, remove, and reorder songs.
|
||||
- **[Cloud Storage Support](./cloud-storage-support)**: In addition to local storage, Koel Plus supports cloud storage services like Amazon S3 (or any S3-compatible service) and Dropbox.
|
||||
- **[Single Sign-On (SSO) Support](./sso)**: Users can log into Koel Plus using their existing credentials from another service like Google.
|
||||
|
||||
Other features are being planned or actively developed, for example:
|
||||
|
||||
- **SSO**: Users can log into Koel using their existing credentials from another service like Google or Facebook.
|
||||
- **Authorization via Proxy-Authorization Header**: Authorize users via a proxy server, allowing Koel to be used in a corporate environment.
|
||||
- **Authentication via Proxy-Authorization Header**: Seamlessly log in users who are already authenticated via a proxy server, allowing Koel to be used in a corporate environment.
|
||||
- **Refined Roles & Permissions**: Create custom roles and assign them to users, controlling what they can and cannot do.
|
||||
- **Custom Themes**: Allow users to customize the look and feel of Koel in addition to the built-in themes.
|
||||
|
||||
## Do you need Koel Plus?
|
||||
Since Koel Plus's flagship feature is multi-library support, it's most useful in a multi-user environment, such as a family or a small organization.
|
||||
Since Koel Plus's flagship feature is multi-library support, it's most useful in a multi-user environment, such as a family or an organization.
|
||||
If you're a single user, you might not need Koel Plus.
|
||||
|
||||
However, if you want to host your media files on a cloud storage service like Amazon S3 or Dropbox, you'll need Koel Plus.
|
||||
Purchasing Koel Plus is also a good way to support the active development of Koel.
|
||||
However, if you want to host your media files on a cloud storage service like Amazon S3 or Dropbox, you'll need Koel Plus.
|
||||
[Purchasing Koel Plus](./purchase-activation) is also a good way to support the active development of Koel.
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ Do NOT place your media files inside Koel’s directory. Though technically poss
|
|||
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.
|
||||
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/cloud-storage-support) for more details.
|
||||
:::
|
||||
|
||||
## Scan via the Web interface
|
||||
|
|
@ -105,7 +105,7 @@ You can now verify that it works by `tail -f storage/logs/laravel.log` while mak
|
|||
## Integration with AWS Lambda
|
||||
|
||||
:::warning Deprecated
|
||||
Though still functional, this method is deprecated in favor of configuring S3 as a [cloud storage](../plus/storage-support).
|
||||
Though still functional, this method is deprecated in favor of configuring S3 as a [cloud storage](../plus/cloud-storage-support).
|
||||
:::
|
||||
|
||||
Starting from version v3.0.0, Koel can work seamlessly with Amazon S3 with the help of the [official Koel-AWS package](https://github.com/koel/koel-aws). This allows you to run Koel in your server and have all media files hosted on S3.
|
||||
|
|
|
|||
Loading…
Reference in a new issue