Configuration - Server

This page provides details about available environment variables (in .env file on server) which you may add/update/remove between updates to control various features.

1. PURCHASE_CODE = The purchase code you must have received after purchase.

2. APP_KEY = Used for signing and encryption. It is recommended to not touch it.

3. APP_URL = This must the public URL to your installation e.g., https://yourapp.com (without trailing slash).

4. API_KEY = This is used to secure API from direct URL access. It can be set to any randomly generated string and must match the server_api_key set in app.

5. DB_DATABASE = This should be the name of the database to use.

6. DB_USERNAME = This must be the username to use when connecting to database.

7. DB_PASSWORD = This is the password corresponding to above user.

8. FILESYSTEM_CLOUD = Can be set to either of s3, gcs or public.

9. CDN_URL = You can assign this variable to make use of almost any CDN service by setting its value to the CDN service's prefix URL.

10. DASHBOARD_STATISTICS = Setting this to true or false will disable/enable charts & statistics on dashboard in admin panel.

11. QUEUE_CONNECTION = Can be either of sync or redis as desired.

12. FACEBOOK_APP_ID = The Facebook app ID obtained earlier in this guide.

13. FACEBOOK_APP_SECRET = The Facebook app secret obtained earlier in this guide.

14. FIREBASE_CREDENTIALS = This must be a valid, absolute path (on server) to the credentials file i.e., xxx-admin-sdk-xxx.json file you downloaded earlier in this guide.

15. GOOGLE_CLIENT_ID = This is the client ID obtained earlier in this guide.

16. SCREENING_SERVICE = Can either be null or one of sightengine, aws or gcp.

17. GIFTS_ENABLED = This could be either true or false.

18. PAYMENT_CURRENCY = This must be a valid 3 characters, ISO currency code e.g., INR or USD.

19. MAIL_FROM_ADDRESS = It is the email address to be used in the From field when sending emails. It is usually same as value for MAIL_USERNAME.

20. MAIL_FROM_NAME = It is name you want to appear in recipient inbox when sending emails e.g., Muly.

21. REFERRAL_ENABLED = This could be either true or false.

22. REFERRAL_REWARD = This is the number of credits to add to referring user's balance upon every successful referral.

23. TELESCOPE_ENABLED = This enables a useful debugging tool accessible at https://yourapp.com/telescope address. Can be set to either true or false.

24. SENTRY_DSN = This can be used to optionally enable error reporting to Sentry in production.

If using SMTP:

1. MAIL_HOST = This must be your mail server e.g., smtp.gmail.com for using Gmail.

2. MAIL_PORT = This is the port your mail server is accessible at. It's commonly set to 465 (for SSL) and 587 (for TLS).

3. MAIL_USERNAME = The username used for authenticating with mail server, usually your email address.

4. MAIL_PASSWORD = The password corresponding to above username.

5. MAIL_ENCRYPTION = Must be either none or any of SSL / TLS.

6. MAIL_DRIVER = This must be set to smtp.

If using Mailgun:

1. MAILGUN_DOMAIN = This is your Mailgun verified domain e.g., mg.yourapp.com.

2. MAILGUN_SECRET = This is your private API key from Mailgun > API keys.

3. MAIL_DRIVER = This must be set to mailgun.

If using S3 (AWS):

1. AWS_ACCESS_KEY_ID = This is the access key ID from AWS console.

2. AWS_SECRET_ACCESS_KEY = This is the secret access key corresponding to above key ID.

3. AWS_BUCKET = The name of the S3 bucket where to keep data.

4. AWS_DEFAULT_REGION = This is the region where your bucket is located e.g., aap-south-1 for Mumbai region.

5. AWS_ENDPOINT = This must be set to null.

6. FILESYSTEM_CLOUD = This must be set to s3.

If using Spaces (DigitalOcean):

1. AWS_ACCESS_KEY_ID = This is the access key ID from DigitalOcean account.

2. AWS_SECRET_ACCESS_KEY = This is the secret access key corresponding to above key ID.

3. AWS_DEFAULT_REGION = This has to be the region code where you created your spaces e.g., sgp1 for Singapore.

4. AWS_ENDPOINT = Should be set to similar to https://fra1.digitaloceanspaces.com where you should replace fra1 with your spaces region code. If the variable does not exist in .env file, you can just add it.

5. FILESYSTEM_CLOUD = This must be set to s3.

If using B2 (Backblaze):

1. AWS_ACCESS_KEY_ID = This is the key ID from app key created in Backblaze.

2. AWS_SECRET_ACCESS_KEY = This is the secret key corresponding to above key ID.

3. AWS_DEFAULT_REGION = This must be us-west-000.

4. AWS_ENDPOINT = This must be https://s3.us-west-000.backblazeb2.com.

5. FILESYSTEM_CLOUD = This must be set to s3.

If using Cloud Storage (GCP):

1. GOOGLE_APPLICATION_CREDENTIALS = This must be a valid, absolute path to JSON key of the service account with Storage Admin role you downloaded earlier in this guide.

2. GOOGLE_CLOUD_KEY_FILE = This must be same value as GOOGLE_APPLICATION_CREDENTIALS above.

3. GOOGLE_CLOUD_PROJECT_ID = This is project ID you chose when creating your Google Cloud project e.g., xxx-xxx-012345.

4. GOOGLE_CLOUD_STORAGE_BUCKET = The name of the Google Cloud Storage bucket in which data has to be stored.

5. FILESYSTEM_CLOUD = This must be set to gcs.

If using MSG91:

1. MSG91_AUTH_KEY = This is the MSG91 key obtained earlier from MSG91 console.

2. OTP_SERVICE = This must be set to msg91.

If using Twilio:

1. TWILIO_SID = This is the account SID from Twilio obtained earlier in this guide.

2. TWILIO_AUTH_TOKEN = This is the auth token from Twilio obtained earlier in this guide.

3. TWILIO_VERIFY_SID = This is the verify service SID from Twilio obtained earlier in this guide.

4. OTP_SERVICE = This must be set to twilio.

If using Play Store IAB:

1. GOOGLE_PLAY_CREDENTIALS = This must be valid, absolute path on server to JSON key of the service account key linked to your Play Console account you downloaded earlier in this guide.

2. GOOGLE_PLAY_PACKAGE_NAME = Your app's package name e.g., com.yourapp.android.

3. PAYMENT_GATEWAY = This must be set to play_store.

If using Instamojo:

1. INSTAMOJO_CLIENT_ID = This is the client ID obtained earlier from your Instamojo account.

2. INSTAMOJO_CLIENT_SECRET = This is the client secret obtained earlier from your Instamojo account.

3. PAYMENT_GATEWAY = This must be set to instamojo.

If using PayPal:

1. PAYPAL_CLIENT_ID = This is the client ID obtained earlier from your PayPal app.

2. PAYPAL_CLIENT_SECRET = This is the client secret obtained earlier from your PayPal app.

3. PAYMENT_GATEWAY = This must be set to paypal.

If using Razorpay:

1. RAZORPAY_KEY_ID = This is the live key ID obtained earlier from your Razorpay account.

2. RAZORPAY_KEY_SECRET = This is the secret key obtained earlier from your Razorpay account.

3. PAYMENT_GATEWAY = This must be set to razorpay.

If using Stripe:

1. STRIPE_PUBLISHABLE_KEY = This is the publishable key obtained earlier from your Stripe account.

2. STRIPE_SECRET_KEY = This is the secret key obtained earlier from your Stripe account.

3. PAYMENT_GATEWAY = This must be set to stripe.

If using Sightengine:

1. SIGHTENGINE_API_USER = This is your Sightengine API user ID.

2. SIGHTENGINE_API_SECRET = This is the secret corresponding to above API user.

3. SIGHTENGINE_CONTINUOUS = If you would like to screen videos videos longer than a minute, you must set this to true.

4. SCREENING_SERVICE = This must be set to sighnengine.

If using Rekognition (AWS):

1. SCREENING_SERVICE = This must be set to aws.

If using Cloud Video Intelligence (GCP):

1. SCREENING_SERVICE = This must be set to gcp.

Please be noted that whenever you change any of the variables in .env file, you must also regenerate app's configuration cache by running below commands when logged in via SSH.

# change to project installation folder
cd /var/www/html

# generate the configuration cache
php artisan config:cache

# fix file permissions (if using LAMP or LEMP)
chown -R www-data:www-data bootstrap/cache
chmod -R 755 bootstrap/cache