docker: add documentation for all variables in .env

.env

@@ -1,63 +1,95 @@
-# Name of your self hosted instance
-# Used in the client apps for identification purposes
+# Description: Name of your self hosted instance. Used in the client apps for identification purposes
+# Required: yes
+# Example: notesnook-instance-sg
 INSTANCE_NAME=
 
-# This should be a randomly generated secret
-# required
+# Description: This secret is used for generating, validating, and introspecting auth tokens. It must be a randomly generated token (preferably >32 characters).
+# Required: yes
 NOTESNOOK_API_SECRET=
 
-# SMTP settings required for delivering emails
-SMTP_USERNAME=
-SMTP_PASSWORD=
-SMTP_HOST=
-SMTP_PORT=
-# optional
-SMTP_REPLYTO_NAME=
-SMTP_REPLYTO_EMAIL=
-NOTESNOOK_SENDER_NAME=
-NOTESNOOK_SENDER_EMAIL=
+# Description: Use this flag to disable creation of new accounts on your instance (i.e. in case it is exposed to the Internet).
+# Required: yes
+# Possible values: 0 for false; 1 for true
+DISABLE_ACCOUNT_CREATION=0
 
-# MessageBird or Twilio are used for 2FA via SMS
-# You can setup either of them or none of them but keep in mind
-# that 2FA via SMS will not work if you haven't set up at least
-# one SMS provider.
-MESSAGEBIRD_ACCESS_KEY=
+# Description: Username for the SMTP connection (most time it is the email address of your account). Check your email provider's documentation to get the appropriate value.
+# Required: yes
+SMTP_USERNAME=
+# Description: Password for the SMTP connection. Check your email provider's documentation to get the appropriate value.
+# Required: yes
+SMTP_PASSWORD=
+# Description: Host on which the the SMTP connection is running. Check your email provider's documentation to get the appropriate value.
+# Required: yes
+# Example: smtp.gmail.com
+SMTP_HOST=
+# Description: Port on which the the SMTP connection is running. Check your email provider's documentation to get the appropriate value.
+# Required: yes
+# Example: 465
+SMTP_PORT=
+# Description: The FROM email address when sending out emails. Must be an email address under your control otherwise sending will fail. Most times it is the same email address as the SMTP_USERNAME.
+# Required: yes
+# Example: support@notesnook.com
+NOTESNOOK_SENDER_EMAIL=
+# Description: The reply-to email is used whenever a user is replying to the email you sent. You can use this to set a different reply-to email address than the one you used to send the email.
+# Required: no
+# Example: support@notesnook.com
+SMTP_REPLYTO_EMAIL=
+
+# Description: Twilio account SID is required for sending SMS with 2FA codes. Learn more here: https://help.twilio.com/articles/14726256820123-What-is-a-Twilio-Account-SID-and-where-can-I-find-it-
+# Required: no
 TWILIO_ACCOUNT_SID=
+# Description: Twilio account auth is required for sending SMS with 2FA codes. Learn more here: https://help.twilio.com/articles/223136027-Auth-Tokens-and-How-to-Change-Them
+# Required: no
 TWILIO_AUTH_TOKEN=
+# Description: The unique string that we created to identify the Service resource.
+# Required: no
+# Example: VAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 TWILIO_SERVICE_SID=
 
-# Server discovery settings
-# The domain must be without protocol
-# e.g. example.org NOT http://example.org
+# Description: This is the public domain for the Authentication server. It can also be the IP address if you don't own a domain name. The domain/IP must be accessible from wherever you are running the Notesnook clients.
+# Required: yes
+# Example: api.notesnook.com
 NOTESNOOK_SERVER_DOMAIN=
+# Description: This is the public domain for the Authentication server. It can also be the IP address if you don't own a domain name. The domain/IP must be accessible from wherever you are running the Notesnook clients.
+# Required: yes
+# Example: auth.streetwriters.co
 IDENTITY_SERVER_DOMAIN=
+# Description: This is the public domain for the Authentication server. It can also be the IP address if you don't own a domain name. The domain/IP must be accessible from wherever you are running the Notesnook clients.
+# Required: yes
+# Example: events.streetwriters.co
 SSE_SERVER_DOMAIN=
 
-# Add the origins on which you want to enable CORS.
-# Leave it empty to allow all origins to access your server.
-# Seperate each origin with a comma
-# e.g. https://app.notesnook.com,http://localhost:3000
+# Description: Add the origins for which you want to allow CORS. Leave it empty to allow all origins to access your server. If you want to allow multiple origins, seperate each origin with a comma.
+# Required: no
+# Example: https://app.notesnook.com,http://localhost:3000
 NOTESNOOK_CORS_ORIGINS= # optional
 
-# url of the web app instance you want to use
-# e.g. https://app.notesnook.com
-# Note: no slashes at the end
+# Description: This is the URL for the web app, and is used by the backend for creating redirect URLs (e.g. after email confirmation etc). 
+# Note: the URL has no slashes at the end
+# Required: yes
+# Example: https://app.notesnook.com
 NOTESNOOK_APP_HOST=
 
-# Minio is used for S3 storage
-# aka. AccessKeyId (must be > 3 characters)
+# Description: Custom username for the root Minio account. Minio is used for storing your attachments. This must be greater than 3 characters in length.
+# Required: no
 MINIO_ROOT_USER=
-# aka. AccessKey (must be > 8 characters)
+# Description: Custom password for the root Minio account. Minio is used for storing your attachments. This must be greater than 8 characters in length.
+# Required: no
 MINIO_ROOT_PASSWORD=
-
-# If you don't want to use Minio, you can use any other S3 compatible
-# storage service.
-S3_ACCESS_KEY=
-S3_ACCESS_KEY_ID=
+# Description: The URL must be accessible from wherever you are running the Notesnook clients. It'll be used by the Notesnook clients for uploading/downloading attachments.
+# You can also set it to a URL for a third-party S3 service like Wasabi S3 or Cloudflare R2.
+# Required: no
+# Example: https://attachments.notesnook.com
 S3_SERVICE_URL=
-S3_REGION=
-# required
+# Description: The bucket name you want to use for storing your attachments.
+# Required: yes
 S3_BUCKET_NAME=attachments
-
-# Disable new accounts creation
-DISABLE_ACCOUNT_CREATION=0
+# Description: If you want to host your attachments on a third party service like Cloudflare R2 or Wasabi S3 instead of the self-hosted Minio instance, you can use put the S3 API AccessKey here. 
+# Required: no
+S3_ACCESS_KEY=
+# Description: If you want to host your attachments on a third party service like Cloudflare R2 or Wasabi S3 instead of the self-hosted Minio instance, you can use put the S3 API AccessKeyId here.
+# Required: no
+S3_ACCESS_KEY_ID=
+# Description: If you want to host your attachments on a third party service like Cloudflare R2 or Wasabi S3 instead of the self-hosted Minio instance, you can use put the S3 API Region here.
+# Required: no
+S3_REGION=