Jelajahi Sumber

update example env

Pouria Ezzati 1 tahun lalu
induk
melakukan
b9a39c94be
1 mengubah file dengan 19 tambahan dan 19 penghapusan
  1. 19 19
      .example.env

+ 19 - 19
.example.env

@@ -7,13 +7,15 @@ SITE_NAME=Kutt
 # The domain that this website is on
 DEFAULT_DOMAIN=localhost:3000
 
-# Generated link length
-LINK_LENGTH=6
+# A passphrase to encrypt JWT. Use a long and secure key.
+JWT_SECRET=securekey
 
 # Database client. Available clients for the supported databases:
 # pg | pg-native | sqlite3 | better-sqlite3 | mysql | mysql2 | oracledb | tedious
 DB_CLIENT=sqlite3
-# SQL database credential details
+# SQLite database file name. Only if you use SQLite.
+DB_FILENAME=data
+# SQL database credential details. Only if you use Postgres or MySQL.
 DB_HOST=localhost
 DB_PORT=5432
 DB_NAME=kutt
@@ -22,34 +24,32 @@ DB_PASSWORD=
 DB_SSL=false
 DB_POOL_MIN=0
 DB_POOL_MAX=10
-# SQLite database file name. Only if you use SQLite.
-DB_FILENAME=data
 
-# Redis host and port
+# Optional - Generated link length
+LINK_LENGTH=6
+
+# Optional - Redis host and port
 REDIS_ENABLED=false
 REDIS_HOST=127.0.0.1
 REDIS_PORT=6379
 REDIS_PASSWORD=
-# Optional: The number for Redis database, between 0 and 15. Defaults to 0.
+# The number for Redis database, between 0 and 15. Defaults to 0.
 # If you don't know what this is, then you probably don't need to change it.
 REDIS_DB=0
 
-# Disable registration
-DISALLOW_REGISTRATION=false
+# Optional - Disable registration. Default is true.
+DISALLOW_REGISTRATION=true
 
-# Disable anonymous link creation
-DISALLOW_ANONYMOUS_LINKS=false
+# Optional - Disable anonymous link creation. Default is true.
+DISALLOW_ANONYMOUS_LINKS=true
 
-# This would be shown to the user on the settings page
+# Optional - This would be shown to the user on the settings page
 # It's only for display purposes and has no other use
 SERVER_IP_ADDRESS=
 
-# Use HTTPS for links with custom domain
+# Optional - Use HTTPS for links with custom domain
 CUSTOM_DOMAIN_USE_HTTPS=false
 
-# A passphrase to encrypt JWT. Use a long and secure key.
-JWT_SECRET=securekey
-
 # Optional - Google Cloud API to prevent from users from submitting malware URLs.
 # Get it from https://developers.google.com/safe-browsing/v4/get-started
 GOOGLE_SAFE_BROWSING_KEY=
@@ -66,11 +66,11 @@ MAIL_USER=
 MAIL_FROM=
 MAIL_PASSWORD=
 
-# Enable rate limitting for some API routes
+# Optional - Enable rate limitting for some API routes
 ENABLE_RATE_LIMIT=false
 
-# The email address that will receive submitted reports.
+# Optional - The email address that will receive submitted reports.
 REPORT_EMAIL=
 
-# Support email to show on the app
+# Optional - Support email to show on the app
 CONTACT_EMAIL=