From 7f793de201ae183743021a3e4a73a39313b3e2b7 Mon Sep 17 00:00:00 2001 From: Bubka <858858+Bubka@users.noreply.github.com> Date: Thu, 24 Mar 2022 15:08:03 +0100 Subject: [PATCH] Update .env.example with new Auth variables --- .env.example | 70 ++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 62 insertions(+), 8 deletions(-) diff --git a/.env.example b/.env.example index 215f9816..93d2f61f 100644 --- a/.env.example +++ b/.env.example @@ -54,7 +54,14 @@ LOG_CHANNEL=daily APP_LOG_LEVEL=notice -# Database config & credentials +# If you're looking for performance improvements, you could install memcached. + +CACHE_DRIVER=file +SESSION_DRIVER=file +FILESYSTEM_DRIVER=local + + +#### Database config & credentials #### DB_CONNECTION=sqlite DB_DATABASE="path/to/your/database.sqlite" @@ -69,13 +76,7 @@ DB_DATABASE="path/to/your/database.sqlite" # DB_PASSWORD=secret -# If you're looking for performance improvements, you could install memcached. -CACHE_DRIVER=file -SESSION_DRIVER=file -FILESYSTEM_DRIVER=local - - -# Mail settings +#### Mail settings #### # Refer your email provider documentation to configure your mail settings # Set a value for every available setting to avoid issue @@ -91,6 +92,59 @@ MAIL_FROM_NAME=null MAIL_FROM_ADDRESS=null +#### Authentication settings #### + +# The default authentication guard +# +# Supported: +# 'web-guard' : The Laravel built-in auth system (default if nulled) +# 'reverse-proxy-guard' : When 2FAuth is deployed behind a reverse-proxy that handle authentication +# +# WARNING +# When using 'reverse-proxy-guard' 2FAuth + +AUTHENTICATION_GUARD= + +# Name of the HTTP headers sent by the reverse proxy that identifies the authenticated user at proxy level. +# Check your proxy documentation to find out how these headers are named (i.e 'REMOTE_USER', 'REMOTE_EMAIL', etc...) +# (only relevant when AUTHENTICATION_GUARD is set to 'reverse-proxy-guard') + +AUTH_PROXY_HEADER_FOR_USER= +AUTH_PROXY_HEADER_FOR_EMAIL= + + +#### WebAuthn settings #### + +# Relying Party name, aka the name of the application. If null, defaults to APP_NAME + +WEBAUTHN_NAME= + +# Relying Party ID. If null, the device will fill it internally. +# See https://webauthn-doc.spomky-labs.com/pre-requisites/the-relying-party#how-to-determine-the-relying-party-id + +WEBAUTHN_ID= + +# Optional image data in BASE64 (128 bytes maximum) or an image url +# See https://webauthn-doc.spomky-labs.com/pre-requisites/the-relying-party#relying-party-icon + +WEBAUTHN_ICON= + +# Use this setting to control how user verification behave during the +# WebAuthn authentication flow. +# +# Most authenticators and smartphones will ask the user to actively verify +# themselves for log in. For example, through a touch plus pin code, +# password entry, or biometric recognition (e.g., presenting a fingerprint). +# The intent is to distinguish one user from any other. +# +# Supported: +# 'required': Will ALWAYS ask for user verification +# 'preferred' (default) : Will ask for user verification IF POSSIBLE +# 'discouraged' : Will NOT ask for user verification (for example, to minimize disruption to the user interaction flow) + +WEBAUTHN_USER_VERIFICATION= + + # Leave the following configuration vars as is. # Unless you like to tinker and know what you're doing.