koel/.env.example

241 lines
8 KiB
Text
Raw Normal View History

APP_NAME=Koel
2022-11-30 09:22:52 +00:00
APP_ENV=production
APP_DEBUG=true
APP_URL=http://localhost:8000
# A comma-separated list of (Koel server) hostnames accepted to access Koel.
# Leave this empty to allow access to Koel with any hostname.
# Example: localhost,192.168.0.1,yourdomain.com
TRUSTED_HOSTS=
2022-11-30 09:22:52 +00:00
# A random 32-char string. You can leave this empty if use php artisan koel:init.
APP_KEY=
2016-06-02 10:05:57 +00:00
# Database connection name, which corresponds to the database driver.
2016-01-31 14:38:32 +00:00
# Possible values are:
# mysql (MySQL/MariaDB - default)
# pgsql (PostgreSQL)
# sqlsrv (Microsoft SQL Server)
# sqlite-persistent (Local sqlite file)
2022-07-18 11:00:37 +00:00
# IMPORTANT: This value must present for `artisan koel:init` command to work.
DB_CONNECTION=mysql
2022-11-30 09:22:52 +00:00
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=koel
DB_USERNAME=koel
DB_PASSWORD=
2016-01-15 02:16:58 +00:00
2022-11-30 09:22:52 +00:00
# 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.
2024-04-26 15:07:17 +00:00
# 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
# The ABSOLUTE path to your media. This value can always be changed later via the web interface.
# Required if you're using the local file system to store your media (STORAGE_DRIVER=local).
MEDIA_PATH=
# S3 or S3-compatible service settings. Required if you're using S3 to store your media (STORAGE_DRIVER=s3).
# Remember to set CORS policy to allow access from your Koel's domain (or "*").
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
# For Cloudflare R2, set this to "auto". For S3 and other services, set this to the region of your bucket.
AWS_REGION=
AWS_ENDPOINT=
AWS_BUCKET=
# Dropbox settings. Required if you're using Dropbox to store your media (STORAGE_DRIVER=dropbox)
# Follow these steps to have these values filled:
# 1. Create a Dropbox app at https://www.dropbox.com/developers/apps
# 2. Run `php artisan koel:setup-dropbox` from the CLI and follow the instructions.
DROPBOX_APP_KEY=
DROPBOX_APP_SECRET=
DROPBOX_REFRESH_TOKEN=
2024-04-26 15:07:17 +00:00
# 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=
2016-09-17 16:00:43 +00:00
# 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.
IGNORE_DOT_FILES=true
2016-01-28 15:19:06 +00:00
2015-12-13 04:42:28 +00:00
# The maximum scan time, in seconds. Increase this if you have a huge library.
2016-01-31 14:38:32 +00:00
# Note: This setting doesn't have effect when scanning via koel:sync.
2015-12-13 04:42:28 +00:00
APP_MAX_SCAN_TIME=600
2016-01-28 15:19:06 +00:00
2017-08-21 20:45:01 +00:00
# The memory limit, in MB, used by the scanning process.
# For example, if you want to set a memory limit of 2048MB, enter "2048" (without
# quotes) here.
MEMORY_LIMIT=
2016-06-13 09:06:57 +00:00
# The streaming method.
2015-12-16 15:41:35 +00:00
# Can be either 'php' (default), 'x-sendfile', or 'x-accel-redirect'
2024-03-08 10:20:46 +00:00
# See https://docs.koel.dev/usage/streaming for more information.
2016-01-28 15:19:06 +00:00
# Note: This setting doesn't have effect if the media needs transcoding (e.g. FLAC).
# ##################################################
# It's HIGHLY recommended to use 'x-sendfile' or 'x-accel-redirect' if
# you plan to use the Koel mobile apps.
# ##################################################
2015-12-16 15:41:35 +00:00
STREAMING_METHOD=php
2016-01-25 10:55:00 +00:00
2022-07-29 08:04:23 +00:00
# Full text search driver.
# Koel supports all drivers supported by Laravel (see https://laravel.com/docs/9.x/scout).
# Available drivers: 'tntsearch' (default), 'database', 'algolia' or 'meilisearch'.
# For Algolia or MeiliSearch, you need to provide the corresponding credentials.
2022-08-02 06:22:08 +00:00
SCOUT_DRIVER=tntsearch
2022-07-27 19:58:20 +00:00
ALGOLIA_APP_ID=
ALGOLIA_SECRET=
2022-07-29 08:04:23 +00:00
MEILISEARCH_HOST=
MEILISEARCH_KEY=
2022-07-27 19:58:20 +00:00
2022-07-18 11:00:37 +00:00
# Last.fm API can be used to fetch artist and album information, as well as to
# allow users to connect to their Last.fm account and scrobble.
# To integrate Koel with Last.fm, create an API account at
# https://www.last.fm/api/account/create and set the credentials here.
# Consult Koel's doc for more information.
LASTFM_API_KEY=
LASTFM_API_SECRET=
2016-01-28 15:19:06 +00:00
2022-07-18 11:00:37 +00:00
# Spotify API can be used to fetch artist and album images.
# To integrate Koel with Spotify, create a Spotify application at
# https://developer.spotify.com/dashboard/applications and set the credentials here.
2024-03-08 10:20:46 +00:00
# Consult Koel's docs for more information.
2022-07-18 11:00:37 +00:00
SPOTIFY_CLIENT_ID=
SPOTIFY_CLIENT_SECRET=
# To integrate Koel with YouTube, set the API key here.
2024-03-08 10:20:46 +00:00
# See https://docs.koel.dev/service-integrations#youtube for more information.
2016-07-14 08:47:50 +00:00
YOUTUBE_API_KEY=
2016-01-25 10:55:00 +00:00
# You can also configure Koel to use a CDN to serve the media files.
# This url must be mapped to the home URL of your Koel's installation.
2022-11-30 09:22:52 +00:00
# No trailing slash.
2016-01-25 10:55:00 +00:00
CDN_URL=
2016-01-28 15:19:06 +00:00
2022-07-18 11:00:37 +00:00
# To transcode FLAC to MP3 and stream it on the fly, make sure the following settings are sane.
2024-03-08 10:20:46 +00:00
# If you don't want to transcode FLAC (i.e. to stream it as-is), set this to false.
TRANSCODE_FLAC=false
# The full path of ffmpeg binary.
2016-01-28 15:19:06 +00:00
FFMPEG_PATH=/usr/local/bin/ffmpeg
2024-04-26 15:07:17 +00:00
2016-06-02 10:05:57 +00:00
# The bit rate of the output mp3 stream. Higher value results in better quality,
2016-01-31 14:38:32 +00:00
# but slower streaming and more bandwidth.
2016-01-28 15:19:06 +00:00
OUTPUT_BIT_RATE=128
2024-04-26 15:07:17 +00:00
2016-06-02 17:53:26 +00:00
# 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
2024-04-26 15:07:17 +00:00
2024-03-12 04:48:57 +00:00
# Whether to create a backup of a song when deleting it from the filesystem.
BACKUP_ON_DELETE=true
2017-08-25 00:30:57 +00:00
2024-04-26 15:07:17 +00:00
2024-03-30 16:49:25 +00:00
# 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=
SSO_GOOGLE_CLIENT_SECRET=
# The domain that users must belong to in order to be able to log in.
SSO_GOOGLE_HOSTED_DOMAIN=yourdomain.com
# Koel can be configured to authenticate users via a reverse proxy.
# To enable this feature, set PROXY_AUTH_ENABLED to true and provide the necessary configuration below.
PROXY_AUTH_ENABLED=false
2024-04-24 20:25:39 +00:00
# The header name that contains the unique identifier for the user
PROXY_AUTH_USER_HEADER=remote-user
# The header name that contains the user's preferred, humanly-readable name
PROXY_AUTH_PREFERRED_NAME_HEADER=remote-preferred-name
2024-04-24 20:25:39 +00:00
# A comma-separated list of allowed proxy IPs or CIDRs, for example, 10.10.1.0/24 or 2001:0db8:/32
# If empty, NO requests will be allowed (which means proxy authentication is disabled).
PROXY_AUTH_ALLOW_LIST=
# Sync logs can be found under storage/logs/. Valid options are:
# all: Log everything (errored-, skipped-, and successfully processed file).
# error: Log errors only. This is the default.
SYNC_LOG_LEVEL=error
2024-04-26 15:07:17 +00:00
# Koel attempts to detect if your website uses HTTPS and generates secure URLs accordingly.
2023-05-17 11:19:14 +00:00
# If this attempt fails for any reason, you can force it by setting this value to true.
2019-05-18 20:43:30 +00:00
FORCE_HTTPS=
2017-08-25 00:30:57 +00:00
# Pusher configuration, for interesting features such as remote controlling.
PUSHER_APP_ID=
PUSHER_APP_KEY=
PUSHER_APP_SECRET=
PUSHER_APP_CLUSTER=
2023-08-20 22:35:58 +00:00
# The following settings are for Koel to send emails, for example to send user invitations and reset passwords.
MAIL_FROM_ADDRESS="hello@example.com"
MAIL_FROM_NAME="${APP_NAME}"
2022-11-30 09:22:52 +00:00
MAIL_MAILER=smtp
MAIL_HOST=mailhog
MAIL_PORT=1025
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null
2024-04-26 15:07:17 +00:00
SQS_PUBLIC_KEY=
SQS_SECRET_KEY=
SQS_QUEUE_PREFIX=
SQS_QUEUE_NAME=
SQS_QUEUE_REGION=
2017-08-25 00:30:57 +00:00
2024-04-26 15:07:17 +00:00
2016-06-02 10:05:57 +00:00
# The variables below are Laravel-specific.
2016-01-25 10:55:00 +00:00
# You can change them if you know what you're doing. Otherwise, just leave them as-is.
2016-09-26 06:30:00 +00:00
BROADCAST_DRIVER=log
2015-12-13 04:42:28 +00:00
CACHE_DRIVER=file
2022-11-30 09:22:52 +00:00
FILESYSTEM_DISK=local
QUEUE_CONNECTION=sync
2015-12-13 04:42:28 +00:00
SESSION_DRIVER=file
2022-11-30 09:22:52 +00:00
SESSION_LIFETIME=120