Novu

Novu

Open Source Notification Infrastructure For Developers

Official integration

Created 3 years ago - Last update 3 years ago

Novu is a fully functional real-time notification center for your web and react apps. The only open-source notifications infrastructure that manages multi-channel content, scheduled notifications, digest engine, user preferences, and delivers Email, SMS, Push and Chat notifications using a single API.

Deployed services

novu-cache

redis:$$cap_REDIS_VERSION

novu-db

mongo:$$cap_MONGO_VERSION

novu-db:/data/db

novu-api

$$cap_NOVU_IMAGE_URL/api:$$cap_NOVU_IMAGE_VERSION

$$cap_NOVU_API_PORT

novu-ws

$$cap_NOVU_IMAGE_URL/ws:$$cap_NOVU_IMAGE_VERSION

$$cap_NOVU_PORT_WEBSOCKET

$$cap_NOVU_IMAGE_URL/web:$$cap_NOVU_IMAGE_VERSION

$$cap_NOVU_PORT_APPLICATION

novu-widget

$$cap_NOVU_IMAGE_URL/widget:$$cap_NOVU_IMAGE_VERSION

$$cap_NOVU_PORT_WIDGET

novu-embed

$$cap_NOVU_IMAGE_URL/embed:$$cap_NOVU_IMAGE_VERSION

$$cap_NOVU_PORT_EMBED

Variables

Application | Version

Default: 0.8.0

$$cap_NOVU_IMAGE_VERSION
Version tag of Novu's Docker images. Check out their valid tags at https://github.com/novuhq/novu/pkgs/container/novu%2Fapi

Application | Image URL

Default: ghcr.io/novuhq/novu

$$cap_NOVU_IMAGE_URL
URL to Novu's Docker images.

Redis | Version

Default: 7.0.5

$$cap_REDIS_VERSION
Version tag of Redis' image. Check out their valid tags at https://hub.docker.com/_/redis/tags

MongoDB | Version

Default: 6.0.2

$$cap_MONGO_VERSION
Version tag of MongoDB's image. Check out their valid tags at https://hub.docker.com/_/mongo/tags

General | Environment

Default: prod

$$cap_ENVIRONMENT
Application environment (e.g `dev`, `test`, `prod`, `ci`, `local`).

General | Docker-Hosted Environment

Default: true

$$cap_NOVU_DOCKER_HOSTED_ENVIRONMENT
Whether to the application is hosted in Docker.

General | User ID

Default: 1000

$$cap_PUID
User ID that the process uses, run `id $user` on your instance to see the ID.

General | Group ID

Default: 1000

$$cap_PGID
Group ID that the process uses, run `id $user` on your instance to see the ID.

Security | JWT Secret

Default: $$cap_gen_random_hex(32)

$$cap_NOVU_JWT_SECRET
Secret for JWT.

Security | Store Encryption Key

Default: $$cap_gen_random_hex(32)

$$cap_NOVU_STORE_ENCRYPTION_KEY
Key for store encryption.

Privacy | Disable User Registration

Default: false

$$cap_NOVU_DISABLE_USER_REGISTRATION
Whether to disable user registration.

API | Port

Default: 3000

$$cap_NOVU_API_PORT
Port of Novu's API.

API | Sentry DSN

Default: undefined

$$cap_NOVU_API_SENTRY_DSN
Sentry's DSN for error tracking. Leave empty to disable.

Redis | Port

Default: 6379

$$cap_REDIS_PORT
Port of Redis' host.

Redis | Database Index

Default: 2

$$cap_REDIS_DB_INDEX
Index of the database in Redis.

MongoDB | Database Name

Default: novu

$$cap_MONGO_DB
Name of the database in MongoDB.

Networking | Embed Port

Default: 4701

$$cap_NOVU_PORT_EMBED
Port of Novu's embed host.

Networking | Widget Port

Default: 4500

$$cap_NOVU_PORT_WIDGET
Port of Novu's widget host.

Networking | Web Port

Default: 4200

$$cap_NOVU_PORT_APPLICATION
Port of Novu's web host.

Networking | WebSocket Port

Default: 3002

$$cap_NOVU_PORT_WEBSOCKET
Port of Novu's WebSocket host.

S3 | Local Stack URL

Default: http://localhost:4566

$$cap_NOVU_S3_LOCAL_STACK
URL to Localstack instance. Leave to `http://localhost:4566` to use local file storage.

S3 | Bucket Name

Default: novu-local

$$cap_NOVU_S3_BUCKET_NAME
Name of the bucket. Leave to `novu-local` to use local file storage.

S3 | Region

Default: us-east-1

$$cap_NOVU_S3_REGION
Region of the storage. Leave to `us-east-1` if using local file storage.

S3 | AWS Access Key ID

Default: test

$$cap_NOVU_AWS_ACCESS_KEY_ID
Access key ID for AWS. Leave to `test` to use local file storage.

S3 | AWS Secret Access Key

Default: test

$$cap_NOVU_AWS_SECRET_ACCESS_KEY
Secret access key for AWS. Leave to `test` to use local file storage.