Self-host Novu with Levelrail
An open source notification infrastructure for email, SMS, push and in-app messages.
- Authornovuhq
- LicenceMIT
- Memory3 GiB
- Services6
How to self-host Novu
-
Pull the images
6 images are pulled on your server.
Show images
ghcr.io/novuhq/novu/api:3.18.0mongo:8.0.17ghcr.io/novuhq/novu/dashboard:3.18.0redis:7-alpineghcr.io/novuhq/novu/worker:3.18.0ghcr.io/novuhq/novu/ws:3.18.0
-
Create the app
6 services start in a single Compose app, with 2 named volume mounts for your data, on ports 3000, 4000, 3002.
-
Fill in the secrets
10 secrets are generated and stored encrypted, 60 settings are preset, you do not have to fill in anything.
-
Open it
Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.
Novu requirements
- Memory
- About 3 GiB
- Architectures
- amd64 unknown, arm64 unknown
- Ports
- 3000, 4000, 3002
- Domain
- Optional, an sslip.io address is used without one
- Settings
- none to fill in
- License
- MIT, permissive license
- Listed. It is in the catalog but not verified. Back up the data volume before changing an image tag.
Install Levelrail first
On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then Novu. New to Levelrail? Install it on a fresh VPS first.
docker pull ghcr.io/glincker/levelrail:latest Then levelrail-cli login --device. See Getting started and the Novu docs page.
Deploy Novu your way
Every format below deploys the same pinned images. Pick the one that fits how you work.
Deploy Novu from the CLI
levelrail-cli templates deploy novu --name my-novu Deploy Novu with the API
curl -X POST -H "Authorization: Bearer $TOKEN" \
https://levelrail.example.com/api/v1/service-templates/novu/deploy Novu configuration
Novu services
| Service | Image | Ports | Volumes |
|---|---|---|---|
| api | ghcr.io/novuhq/novu/api:3.18.0 | 3000 | none |
| mongodb | mongo:8.0.17 | none | mongo_data -> /data/db |
| novu | ghcr.io/novuhq/novu/dashboard:3.18.0 | 4000 | none |
| redis | redis:7-alpine | none | redis_data -> /data |
| worker | ghcr.io/novuhq/novu/worker:3.18.0 | none | none |
| ws | ghcr.io/novuhq/novu/ws:3.18.0 | 3002 | none |
Novu environment variables
| Variable | Service | Value |
|---|---|---|
| API_ROOT_URL | api | Preset by the template |
| AWS_ACCESS_KEY_ID | api | Preset by the template |
| AWS_SECRET_ACCESS_KEY | api | Preset by the template |
| FRONT_BASE_URL | api | Preset by the template |
| IS_API_IDEMPOTENCY_ENABLED | api | Preset by the template |
| IS_API_RATE_LIMITING_ENABLED | api | Preset by the template |
| IS_NEW_MESSAGES_API_RESPONSE_ENABLED | api | Preset by the template |
| IS_SELF_HOSTED | api | Preset by the template |
Show all 70 variables
- IS_V2_ENABLEDapiPreset by the template
- JWT_SECRETapiGenerated at deploy
- MONGO_AUTO_CREATE_INDEXESapiPreset by the template
- MONGO_MAX_POOL_SIZEapiPreset by the template
- MONGO_MIN_POOL_SIZEapiPreset by the template
- MONGO_URLapiGenerated at deploy
- NEW_RELIC_ENABLEDapiPreset by the template
- NODE_ENVapiPreset by the template
- NOVU_SECRET_KEYapiGenerated at deploy
- PORTapiPreset by the template
- REDIS_CACHE_SERVICE_HOSTapiPreset by the template
- REDIS_CACHE_SERVICE_PORTapiPreset by the template
- REDIS_HOSTapiPreset by the template
- REDIS_PORTapiPreset by the template
- S3_BUCKET_NAMEapiPreset by the template
- S3_REGIONapiPreset by the template
- STORE_ENCRYPTION_KEYapiGenerated at deploy
- SUBSCRIBER_WIDGET_JWT_EXPIRATION_TIMEapiPreset by the template
- MONGO_INITDB_ROOT_PASSWORDmongodbGenerated at deploy
- MONGO_INITDB_ROOT_USERNAMEmongodbPreset by the template
- VITE_API_HOSTNAMEnovuPreset by the template
- VITE_WEBSOCKET_HOSTNAMEnovuPreset by the template
- API_ROOT_URLworkerPreset by the template
- AWS_ACCESS_KEY_IDworkerPreset by the template
- AWS_SECRET_ACCESS_KEYworkerPreset by the template
- BROADCAST_QUEUE_CHUNK_SIZEworkerPreset by the template
- IS_SELF_HOSTEDworkerPreset by the template
- MONGO_AUTO_CREATE_INDEXESworkerPreset by the template
- MONGO_MAX_POOL_SIZEworkerPreset by the template
- MONGO_MIN_POOL_SIZEworkerPreset by the template
- MONGO_URLworkerGenerated at deploy
- MULTICAST_QUEUE_CHUNK_SIZEworkerPreset by the template
- NEW_RELIC_ENABLEDworkerPreset by the template
- NODE_ENVworkerPreset by the template
- PORTworkerPreset by the template
- REDIS_CACHE_SERVICE_HOSTworkerPreset by the template
- REDIS_CACHE_SERVICE_PORTworkerPreset by the template
- REDIS_HOSTworkerPreset by the template
- REDIS_PORTworkerPreset by the template
- S3_BUCKET_NAMEworkerPreset by the template
- S3_REGIONworkerPreset by the template
- STORE_ENCRYPTION_KEYworkerGenerated at deploy
- SUBSCRIBER_WIDGET_JWT_EXPIRATION_TIMEworkerPreset by the template
- AWS_ACCESS_KEY_IDwsPreset by the template
- AWS_SECRET_ACCESS_KEYwsPreset by the template
- IS_SELF_HOSTEDwsPreset by the template
- JWT_SECRETwsGenerated at deploy
- MONGO_AUTO_CREATE_INDEXESwsPreset by the template
- MONGO_MAX_POOL_SIZEwsPreset by the template
- MONGO_MIN_POOL_SIZEwsPreset by the template
- MONGO_URLwsGenerated at deploy
- NEW_RELIC_ENABLEDwsPreset by the template
- NODE_ENVwsPreset by the template
- PORTwsPreset by the template
- REDIS_CACHE_SERVICE_HOSTwsPreset by the template
- REDIS_CACHE_SERVICE_PORTwsPreset by the template
- REDIS_HOSTwsPreset by the template
- REDIS_PORTwsPreset by the template
- S3_BUCKET_NAMEwsPreset by the template
- S3_REGIONwsPreset by the template
- STORE_ENCRYPTION_KEYwsGenerated at deploy
- SUBSCRIBER_WIDGET_JWT_EXPIRATION_TIMEwsPreset by the template
Ports and volumes
- Ports
- 3000, 4000, 3002
- Volumes
- 2 named mounts: mongo_data -> /data/db, redis_data -> /data
Novu FAQ
How much memory does Novu need?
The catalog lists about 3 GiB of memory for Novu across its 6 services.
Does Novu run on arm64?
For Novu, arm64 support is not confirmed; amd64 is unknown.
What licence is Novu under?
Novu is licensed under MIT, which is permissive, with few conditions on reuse.
Does Novu need configuration before it starts?
No. The template fills in its own defaults and generates secrets at deploy time.
Which database does Novu bundle?
The template includes MongoDB and Redis, running as its own service.
Which ports does Novu use?
Novu listens on ports 3000, 4000 and 3002 inside the stack.
Where does Novu keep its data?
In named volumes: mongo_data mounted at /data/db and redis_data mounted at /data.
Can I deploy Novu on Dokploy or Dokku?
The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list has an entry with the id novu for this app, so check that entry as well. Dokku deploys container images with its own commands, so the pinned image ghcr.io/novuhq/novu/api:3.18.0, mongo:8.0.17, ghcr.io/novuhq/novu/dashboard:3.18.0, redis:7-alpine, ghcr.io/novuhq/novu/worker:3.18.0, ghcr.io/novuhq/novu/ws:3.18.0 is what you deploy there.