chore: add SFTP config to .env.example

.env.example

@@ -21,18 +21,17 @@ DB_DATABASE=koel
 DB_USERNAME=koel
 DB_PASSWORD=
 
-
 # Some providers (e.g. Heroku) provide a "database URL" instead separated config values, which
 # you can use here instead.
 DATABASE_URL=
 
-
 # The absolute path to the root CA bundle if you're connecting to the MySQL database via SSL.
 MYSQL_ATTR_SSL_CA=
 
 
 # The storage driver. Valid values are:
 # local: Store files on the server's local filesystem.
+# sftp: Store files on an SFTP server.
 # s3: Store files on Amazon S3 or a S3-compatible service (e.g. Cloudflare R2 or DigitalOcean Spaces). Koel Plus only.
 # dropbox: Store files on Dropbox. Koel Plus only.
 STORAGE_DRIVER=local
@@ -62,6 +61,23 @@ DROPBOX_APP_SECRET=
 DROPBOX_REFRESH_TOKEN=
 
 
+# SFTP settings. Required if you're using SFTP to store your media (STORAGE_DRIVER=sftp).
+SFTP_HOST=
+SFTP_PORT=
+
+# The absolute path of the directory to store the media files on the SFTP server.
+# Make sure the directory exists and is writable by the SFTP user.
+SFTP_ROOT=
+
+# You can use either a username/password pair…
+SFTP_USERNAME=
+SFTP_PASSWORD=
+
+# …or private key authentication:
+SFTP_PRIVATE_KEY=
+SFTP_PASSPHRASE=
+
+
 # By default, Koel ignores dot files and folders. This greatly improves performance if your media
 # root have folders like .git or .cache. If by any chance your media files are under a dot folder,
 # set the following setting to false.
@@ -136,19 +152,23 @@ TRANSCODE_FLAC=false
 # The full path of ffmpeg binary.
 FFMPEG_PATH=/usr/local/bin/ffmpeg
 
+
 # The bit rate of the output mp3 stream. Higher value results in better quality,
 # but slower streaming and more bandwidth.
 OUTPUT_BIT_RATE=128
 
+
 # Whether to allow song downloading.
 # Note that if you're downloading more than one song, Koel will zip them up
 # using PHP's ZipArchive. So if the module isn't available in the current
 # environment, such a download will (silently) fail.
 ALLOW_DOWNLOAD=true
 
+
 # Whether to create a backup of a song when deleting it from the filesystem.
 BACKUP_ON_DELETE=true
 
+
 # If using SSO, set the providers details here. Koel will automatically enable SSO if these values are set.
 # Create an OAuth client and get these values from https://console.developers.google.com/apis/credentials
 SSO_GOOGLE_CLIENT_ID=
@@ -174,6 +194,7 @@ PROXY_AUTH_ALLOW_LIST=
 # error: Log errors only. This is the default.
 SYNC_LOG_LEVEL=error
 
+
 # Koel attempts to detect if your website uses HTTPS and generates secure URLs accordingly.
 # If this attempt fails for any reason, you can force it by setting this value to true.
 FORCE_HTTPS=
@@ -196,12 +217,14 @@ MAIL_USERNAME=null
 MAIL_PASSWORD=null
 MAIL_ENCRYPTION=null
 
+
 SQS_PUBLIC_KEY=
 SQS_SECRET_KEY=
 SQS_QUEUE_PREFIX=
 SQS_QUEUE_NAME=
 SQS_QUEUE_REGION=
 
+
 # The variables below are Laravel-specific.
 # You can change them if you know what you're doing. Otherwise, just leave them as-is.
 BROADCAST_DRIVER=log