diff --git a/docs/examples/.env b/docs/examples/.env index b153d04..5291b78 100644 --- a/docs/examples/.env +++ b/docs/examples/.env @@ -7,6 +7,11 @@ APP_URL="https://dev.caldwell.digital" APP_SECRET="70169beadfbc8101c393cbfbba27a313" APP_ENV=prod +# Mercure is a Caddy module built into the webserver +# that facilitates the usage of websockets to transmit +# real time data (download progress, etc.) +MERCURE_JWT_SECRET="!ChangeThisMercureHubJWTSecretKey!" + # Use the DATABASE_URL below to use the MariaDB container # provided in the example.compose.yml file, or remove this # line and fill in the details of your own MySQL/MariaDB server @@ -19,39 +24,46 @@ DATABASE_URL="mysql://root:password@database:3306/app?serverVersion=10.6.19.2-Ma # This key is never saved anywhere # else and is passed to Torrentio # to retrieve download options -#REAL_DEBRID_KEY="" +REAL_DEBRID_KEY="" -# Enter you TMDB API key +# Enter your TMDB API key # This is used to provide rich search results # when searching for media and rendering the # Popular Movies and TV Shows section. -#TMDB_API= - -REAL_DEBRID_KEY="" -TMDB_API=eyJhbGciOiJIUzI1NiJ9.eyJhdWQiOiI0ZTJjYjJhOGUzOGJhNjdiNjVhOGU1NGM0ZWI1MzhmOCIsIm5iZiI6MTczNzkyNjA0NC41NjQsInN1YiI6IjY3OTZhNTljYzdiMDFiNzJjNzIzZWM5YiIsInNjb3BlcyI6WyJhcGlfcmVhZCJdLCJ2ZXJzaW9uIjoxfQ.e8DbNe9qrSBC1y-ANRv-VWBAtls-ZS2r7aNCiI68mpw - - -MERCURE_JWT_SECRET="!ChangeThisMercureHubJWTSecretKey!" +TMDB_API="" # Use your own Redis instance or use the # below value to use the container included # in the example compose.yml file. REDIS_HOST="redis://redis" +### Auth ### +AUTH_METHOD=form_login + +# OIDC +OIDC_WELL_KNOWN_URL= +OIDC_CLIENT_ID= +OIDC_CLIENT_SECRET= +# Allows you to skip the login page and directly +# rely on your IdP for auth. +OIDC_BYPASS_FORM_LOGIN= + + # LDAP Config: To use LDAP, enter the below fields # and run 'php bin/console config:set auth.method ldap' -LDAP_HOST= -LDAP_PORT= -LDAP_ENCRYPTION= -LDAP_BASE_DN= -LDAP_BIND_USER= -LDAP_BIND_PASS= -LDAP_DN_STRING= -LDAP_UID_KEY="uid" +# (LDAP is still in progress and not ready for use) +#LDAP_HOST= +#LDAP_PORT= +#LDAP_ENCRYPTION= +#LDAP_BASE_DN= +#LDAP_BIND_USER= +#LDAP_BIND_PASS= +#LDAP_DN_STRING= +#LDAP_UID_KEY="uid" # LDAP group that identifies an Admin # Users with this LDAP group will automatically # get the admin role in this system. -LDAP_ADMIN_ROLE_DN="" -LDAP_EMAIL_ATTRIBUTE=mail -LDAP_USERNAME_ATTRIBUTE=uid -LDAP_NAME_ATTRIBUTE=displayname +#LDAP_ADMIN_ROLE_DN="" +#LDAP_EMAIL_ATTRIBUTE=mail +#LDAP_USERNAME_ATTRIBUTE=uid +#LDAP_NAME_ATTRIBUTE=displayname