mirror of
https://github.com/streetwriters/notesnook-sync-server.git
synced 2026-08-13 03:50:19 +02:00
Ibaraki DoujiandGitHub
3c7327d3c7
* docker: update .env and docker-compose.yml for SMTP and new services * docker: add external MinIO, MongoDB, and GarageHQ examples with setup instructions * docs: update README with dotenv docker setup instructions and configuration redirect for external services * docker: update service dependency condition for setup-themes in docker-compose.yml * chore: update example URLs in .env for public services
100 lines
4.9 KiB
Bash
100 lines
4.9 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 (optional) ###
|
|
# ================================================================================
|
|
# WARNING: If SMTP is not configured, email 2FA and password-reset emails will
|
|
# NOT work. Newly created users MUST change 2FA to an Authenticator app:
|
|
# Settings > Auth > Change 2FA method
|
|
# ================================================================================
|
|
# SMTP is used 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: no
|
|
SMTP_USERNAME=
|
|
# Description: Password for the SMTP connection. Check your email provider's documentation to get the appropriate value.
|
|
# Required: no
|
|
SMTP_PASSWORD=
|
|
# Description: Host on which the the SMTP connection is running. Check your email provider's documentation to get the appropriate value.
|
|
# Required: no
|
|
# 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: no
|
|
# 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.
|
|
# Note: this value is passed to the server as NOTESNOOK_CORS internally.
|
|
# 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.yourdomain.com
|
|
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.yourdomain.com
|
|
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.yourdomain.com
|
|
ATTACHMENTS_SERVER_PUBLIC_URL=http://localhost:9000
|
|
# Description: This is the public URL for the Notesnook sync API (browser-reachable; used by Monograph).
|
|
# Required: yes
|
|
# Example: https://api.yourdomain.com
|
|
NOTESNOOK_API_PUBLIC_URL=http://localhost:5264
|
|
|
|
# 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=
|
|
|
|
# Optional: only needed when using `docker compose --profile extras up`
|
|
# Description: Public URL for the CORS proxy service
|
|
CORS_PROXY_PUBLIC_URL=http://localhost:3001
|
|
# Description: Allowed origins for the CORS proxy (* for all origins)
|
|
CORS_PROXY_ALLOWED_ORIGINS=*
|
|
# Description: Public URL for the Inbox API service
|
|
INBOX_API_PUBLIC_URL=http://localhost:5181
|
|
# Description: Public URL for the Themes server
|
|
THEMES_SERVER_PUBLIC_URL=http://localhost:9200
|
|
# Description: Git repository URL for the Themes server
|
|
THEMES_REPO_URL=https://github.com/streetwriters/notesnook-themes.git
|