docs: 📝 Updated the .env.example to be more self explanatory

This commit is contained in:
IceToast 2021-12-28 14:09:18 +01:00
parent 669939f8c3
commit 3750dc45d1

View file

@ -1,70 +1,76 @@
### --- App Settings --- ###
APP_NAME=Controlpanel.gg APP_NAME=Controlpanel.gg
APP_ENV=production APP_ENV=production
APP_KEY= APP_KEY=
APP_DEBUG=false APP_DEBUG=false
APP_URL=http://localhost APP_URL=http://localhost
#list with timezones https://www.php.net/manual/en/timezones.php # List with timezones https://www.php.net/manual/en/timezones.php
APP_TIMEZONE=UTC APP_TIMEZONE=UTC
### --- App Settings End --- ###
### --- Localization settings --- ###
# If set to true, Language is chosen automatically depending on the users browserlanguage. # If set to true, Language is chosen automatically depending on the users browserlanguage.
DYNAMIC_LOCALE = false DYNAMIC_LOCALE = false
# The language of the Dashboard. This is also the fallback if dynamic_locale is true but no translation is found # The language of the Dashboard. This is also the fallback if dynamic_locale is true but no translation is found
LOCALE=en LOCALE=en
# You can grab the Language-Codes for the Datatables from this Website https://datatables.net/plug-ins/i18n/ # You can grab the Language-Codes for the Datatables from this Website https://datatables.net/plug-ins/i18n/
DATATABLE_LOCALE=en-gb DATATABLE_LOCALE=en-gb
#The languages you DO NOT want to support on your Controlpanel split by comma. #The languages you DO NOT want to support on your Controlpanel split by comma.
#Remove the language to make it available #Remove the language to make it available
UNSUPPORTED_LOCALES=german,italian,chinese UNSUPPORTED_LOCALES=german,italian,chinese
### --- Localization settings End --- ###
### --- DB Settings (required) --- ###
DB_CONNECTION=mysql DB_CONNECTION=mysql
DB_HOST=127.0.0.1 DB_HOST=127.0.0.1
DB_PORT=3306 DB_PORT=3306
DB_DATABASE=dashboard DB_DATABASE=dashboard
DB_USERNAME=dashboarduser DB_USERNAME=dashboarduser
DB_PASSWORD= DB_PASSWORD=
### --- DB Settings End --- ###
#without a pterodactyl api token, this panel won't work! ### --- Payment Options (required for payments) --- ###
PTERODACTYL_TOKEN= # Paypal API Credentials - https://developer.paypal.com/docs/integration/direct/rest/ - Sandbox credentials are being used when APP_ENV is set to local
#paypal details, you only need sandbox for testing! you can do this by setting the APP_ENV to local
PAYPAL_SANDBOX_SECRET= PAYPAL_SANDBOX_SECRET=
PAYPAL_SANDBOX_CLIENT_ID= PAYPAL_SANDBOX_CLIENT_ID=
PAYPAL_SECRET= PAYPAL_SECRET=
PAYPAL_CLIENT_ID= PAYPAL_CLIENT_ID=
# Stripe API Credentials - https://dashboard.stripe.com/account/apikeys - Test credentials are being used when APP_ENV is set to local
#stripe details, you only need "test" for testing! you can do this by setting the APP_ENV to local
STRIPE_TEST_SECRET= STRIPE_TEST_SECRET=
STRIPE_SECRET= STRIPE_SECRET=
#https://dashboard.stripe.com/webhooks -> webhook route: <your.controlpanel.gg>/payment/StripeWebhooks #https://dashboard.stripe.com/webhooks -> webhook route: <your.controlpanel.gg>/payment/StripeWebhooks
STRIPE_ENDPOINT_TEST_SECRET= STRIPE_ENDPOINT_TEST_SECRET=
STRIPE_ENDPOINT_SECRET= STRIPE_ENDPOINT_SECRET=
#stripe payment methods, comma seperated list of methods you want to support: # Stripe payment methods - comma seperated list of payment methods that are enabled https://stripe.com/docs/payments/payment-methods/integration-options
#read into https://stripe.com/docs/payments/payment-methods/integration-options and/or https://stripe.com/docs/payments/payment-methods/overview
#Method needs to support the currency
STRIPE_METHODS= STRIPE_METHODS=
### --- Payment Options End --- ###
#set-up for extra discord verification ### --- Discord Settings (optional) --- ###
# Discord API Credentials - https://discordapp.com/developers/applications/
DISCORD_CLIENT_ID= DISCORD_CLIENT_ID=
DISCORD_CLIENT_SECRET= DISCORD_CLIENT_SECRET=
#set-up will join users automaticly to your discord # Bot Settings - will join users to your discord
DISCORD_BOT_TOKEN= DISCORD_BOT_TOKEN=
DISCORD_GUILD_ID= DISCORD_GUILD_ID=
#set-up will give the verified user the given role # Discord role that will be assigned to users when they register
DISCORD_ROLE_ID= DISCORD_ROLE_ID=
### --- Discord Settings End --- ###
#nesseary URL's ### --- Controlpanel Settings (required) --- ###
PTERODACTYL_URL=https://panel.controlpanel.gg # Controlpanel URL Settings - URLs must not end with a slash!
PTERODACTYL_URL=https://panel.controlpanel.gg # required
PHPMYADMIN_URL=https://mysql.controlpanel.gg #optional. remove to remove database button PHPMYADMIN_URL=https://mysql.controlpanel.gg #optional. remove to remove database button
DISCORD_INVITE_URL=https://discord.gg/vrUYdxG4wZ DISCORD_INVITE_URL=https://discord.gg/vrUYdxG4wZ #optional
# Admin API Token from Pterodactyl Panel - Nececary for the Panel to work
PTERODACTYL_TOKEN=
### --- Controlpanel Settings End --- ###
#GOOGLE RECAPTCHA # Google Recaptcha API Credentials - https://www.google.com/recaptcha/admin - reCaptcha V2 (not v3)
RECAPTCHA_SITE_KEY=6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI RECAPTCHA_SITE_KEY=6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI
RECAPTCHA_SECRET_KEY=6LeIxAcTAAAAAGG-vFI1TnRWxMZNFuojJ4WifJWe RECAPTCHA_SECRET_KEY=6LeIxAcTAAAAAGG-vFI1TnRWxMZNFuojJ4WifJWe
# Mail Server Settings - (HOST -> SMTP Server)
MAIL_MAILER=smtp MAIL_MAILER=smtp
MAIL_HOST=mailhog MAIL_HOST=mailhog
MAIL_PORT=1025 MAIL_PORT=1025
@ -75,10 +81,11 @@ MAIL_FROM_ADDRESS=null
MAIL_FROM_NAME="${APP_NAME}" MAIL_FROM_NAME="${APP_NAME}"
#you can leave everything below the way it is # Laravel Logging Settings - https://laravel.com/docs/5.7/logging - Not needed to be changed
LOG_CHANNEL=stack LOG_CHANNEL=stack
LOG_LEVEL=debug LOG_LEVEL=debug
# Do not change anything below this line
BROADCAST_DRIVER=log BROADCAST_DRIVER=log
CACHE_DRIVER=file CACHE_DRIVER=file
QUEUE_CONNECTION=database QUEUE_CONNECTION=database