diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index d42df48c..c88d813c 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -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' }, ] diff --git a/docs/plus/storage-support.md b/docs/plus/cloud-storage-support.md similarity index 97% rename from docs/plus/storage-support.md rename to docs/plus/cloud-storage-support.md index 1d0655db..4a05ae40 100644 --- a/docs/plus/storage-support.md +++ b/docs/plus/cloud-storage-support.md @@ -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: Create a Cloudflare R2 bucket @@ -105,10 +105,10 @@ Koel Plus also supports using Dropbox as a storage driver, although the setup is Set sufficient app permissions 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. diff --git a/docs/plus/sso.md b/docs/plus/sso.md index cc829956..7410503b 100644 --- a/docs/plus/sso.md +++ b/docs/plus/sso.md @@ -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.