mirror of
https://github.com/streetwriters/notesnook-sync-server.git
synced 2026-02-12 19:22:45 +00:00
83 lines
4.4 KiB
Bash
83 lines
4.4 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=
|
|
|
|
# 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: 0 for false; 1 for true
|
|
DISABLE_ACCOUNT_CREATION=0
|
|
|
|
# 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=
|
|
|
|
# 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=
|
|
|
|
# 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
|
|
|
|
# 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=
|
|
|
|
# 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=
|
|
# 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.
|
|
# Required: no
|
|
# Example: https://attachments.notesnook.com
|
|
S3_SERVICE_URL=
|