# Self-host Novu

> An open source notification infrastructure for email, SMS, push and in-app messages.

- Page: https://levelrail.com/templates/novu/
- JSON: https://levelrail.com/templates/novu.json
- Category: Developer Tools
- Licence: MIT (Permissive license)
- Source: https://github.com/novuhq/novu
- Upstream docs: https://docs.novu.co/community/self-hosting-novu/overview

## Requirements
- Memory: about 3 GiB
- amd64: unknown, arm64: unknown
- Needs configuration before start: no
- Pinned image tag: 3.18.0

## Services

| Service | Image | Tag | 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 |

## Environment

| Service | Variable | Kind |
| --- | --- | --- |
| api | API_ROOT_URL | preset |
| api | AWS_ACCESS_KEY_ID | preset |
| api | AWS_SECRET_ACCESS_KEY | preset |
| api | FRONT_BASE_URL | preset |
| api | IS_API_IDEMPOTENCY_ENABLED | preset |
| api | IS_API_RATE_LIMITING_ENABLED | preset |
| api | IS_NEW_MESSAGES_API_RESPONSE_ENABLED | preset |
| api | IS_SELF_HOSTED | preset |
| api | IS_V2_ENABLED | preset |
| api | JWT_SECRET | generated |
| api | MONGO_AUTO_CREATE_INDEXES | preset |
| api | MONGO_MAX_POOL_SIZE | preset |
| api | MONGO_MIN_POOL_SIZE | preset |
| api | MONGO_URL | generated |
| api | NEW_RELIC_ENABLED | preset |
| api | NODE_ENV | preset |
| api | NOVU_SECRET_KEY | generated |
| api | PORT | preset |
| api | REDIS_CACHE_SERVICE_HOST | preset |
| api | REDIS_CACHE_SERVICE_PORT | preset |
| api | REDIS_HOST | preset |
| api | REDIS_PORT | preset |
| api | S3_BUCKET_NAME | preset |
| api | S3_REGION | preset |
| api | STORE_ENCRYPTION_KEY | generated |
| api | SUBSCRIBER_WIDGET_JWT_EXPIRATION_TIME | preset |
| mongodb | MONGO_INITDB_ROOT_PASSWORD | generated |
| mongodb | MONGO_INITDB_ROOT_USERNAME | preset |
| novu | VITE_API_HOSTNAME | preset |
| novu | VITE_WEBSOCKET_HOSTNAME | preset |
| worker | API_ROOT_URL | preset |
| worker | AWS_ACCESS_KEY_ID | preset |
| worker | AWS_SECRET_ACCESS_KEY | preset |
| worker | BROADCAST_QUEUE_CHUNK_SIZE | preset |
| worker | IS_SELF_HOSTED | preset |
| worker | MONGO_AUTO_CREATE_INDEXES | preset |
| worker | MONGO_MAX_POOL_SIZE | preset |
| worker | MONGO_MIN_POOL_SIZE | preset |
| worker | MONGO_URL | generated |
| worker | MULTICAST_QUEUE_CHUNK_SIZE | preset |
| worker | NEW_RELIC_ENABLED | preset |
| worker | NODE_ENV | preset |
| worker | PORT | preset |
| worker | REDIS_CACHE_SERVICE_HOST | preset |
| worker | REDIS_CACHE_SERVICE_PORT | preset |
| worker | REDIS_HOST | preset |
| worker | REDIS_PORT | preset |
| worker | S3_BUCKET_NAME | preset |
| worker | S3_REGION | preset |
| worker | STORE_ENCRYPTION_KEY | generated |
| worker | SUBSCRIBER_WIDGET_JWT_EXPIRATION_TIME | preset |
| ws | AWS_ACCESS_KEY_ID | preset |
| ws | AWS_SECRET_ACCESS_KEY | preset |
| ws | IS_SELF_HOSTED | preset |
| ws | JWT_SECRET | generated |
| ws | MONGO_AUTO_CREATE_INDEXES | preset |
| ws | MONGO_MAX_POOL_SIZE | preset |
| ws | MONGO_MIN_POOL_SIZE | preset |
| ws | MONGO_URL | generated |
| ws | NEW_RELIC_ENABLED | preset |
| ws | NODE_ENV | preset |
| ws | PORT | preset |
| ws | REDIS_CACHE_SERVICE_HOST | preset |
| ws | REDIS_CACHE_SERVICE_PORT | preset |
| ws | REDIS_HOST | preset |
| ws | REDIS_PORT | preset |
| ws | S3_BUCKET_NAME | preset |
| ws | S3_REGION | preset |
| ws | STORE_ENCRYPTION_KEY | generated |
| ws | SUBSCRIBER_WIDGET_JWT_EXPIRATION_TIME | preset |

## Deploy

### CLI

```bash
levelrail-cli templates deploy novu --name my-novu
```

### API

```bash
curl -X POST -H "Authorization: Bearer $TOKEN" \
  https://levelrail.example.com/api/v1/service-templates/novu/deploy
```

Create a token in the dashboard first. This one-click route deploys it as a trial app you can keep or remove.

## Questions

### 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.

Self-host Novu, Novu docker compose file, deploy Novu on a VPS: this page lists the pinned image, ports, volumes and the commands for each.
