mirror of
https://github.com/streetwriters/notesnook-sync-server.git
synced 2026-02-12 11:12:44 +00:00
dd05c55875
* Add KNOWN_PROXIES * Add known proxy setup in Startup.cs Refactor forwarded headers configuration to use a variable for options. * Document KNOWN_PROXIES in .env file Added documentation for KNOWN_PROXIES environment variable * Clean up Restored license comments and formatting in Constants.cs. * Apply suggestion from @thecodrr * Added KnownProxies functionality at Streetwriters.Common level --------- Co-authored-by: Abdullah Atta <thecodrr@protonmail.com>
78 lines
3.7 KiB
Bash
78 lines
3.7 KiB
Bash
# Description: Name of your self hosted instance. Used in the client apps for identification purposes
|
|
# Required: yes
|
|
# Example: notesnook-instance-sg
|
|
INSTANCE_NAME=self-hosted-notesnook-instance
|
|
|
|
# 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=
|
|
|
|
# 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: true/false
|
|
DISABLE_SIGNUPS=false
|
|
|
|
### SMTP Configuration ###
|
|
# SMTP Configuration is required for sending emails for password reset, 2FA emails etc. You can get SMTP settings from your email provider.
|
|
|
|
# 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: 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=
|
|
|
|
# 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=
|
|
|
|
# Description: Add known proxies for incoming HTTP requests
|
|
# Required: no
|
|
# Example: 192.168.1.2,192.168.1.3
|
|
KNOWN_PROXIES=
|
|
|
|
# Description: This is the public 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_PUBLIC_URL=https://app.notesnook.com
|
|
# Description: This is the public URL for the monograph frontend.
|
|
# Required: yes
|
|
# Example: https://monogr.ph
|
|
MONOGRAPH_PUBLIC_URL=http://localhost:6264
|
|
# Description: This is the public URL for the Authentication server. Used for generating email confirmation & password reset URLs.
|
|
# Required: yes
|
|
# Example: https://auth.streetwriters.co
|
|
AUTH_SERVER_PUBLIC_URL=http://localhost:8264
|
|
# Description: This is the public URL for the S3 attachments server (minio). It'll be used by the Notesnook clients for uploading/downloading attachments.
|
|
# Required: yes
|
|
# Example: https://attachments.notesnook.com
|
|
ATTACHMENTS_SERVER_PUBLIC_URL=http://localhost:9000
|
|
|
|
# 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=
|
|
# 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=
|