There are many features offered by Novu. They include:<\/p>\n\n\n\n
- \n
- Consolidated API for diverse messaging platforms (In-App, Email, SMS, Push, Chat)<\/li>\n\n\n\n
- Inclusive CMS for sophisticated layout and design control<\/li>\n\n\n\n
- Swift and seamless setup and integration<\/li>\n\n\n\n
- Driven by a vibrant community of users and developers<\/li>\n\n\n\n
- Effortlessly oversee notifications across multiple channels<\/li>\n\n\n\n
- Streamlined debugging and analysis of cross-channel messages through a unified dashboard<\/li>\n\n\n\n
- Incorporate an embeddable notification centre with live updates<\/li>\n\n\n\n
- Upcoming feature: Safeguard against missing variables<\/li>\n<\/ul>\n\n\n\n
Follow the below steps to install and use Novu.<\/p>\n\n\n\n\n\n
Step 1. Install Novu on Your System<\/h2>\n\n\n\n
Novu offers two deployment methods:<\/p>\n\n\n\n
- \n
- The cloud option<\/li>\n\n\n\n
- Self-hosted Option<\/li>\n<\/ul>\n\n\n\n
Install Docker and Docker Compose<\/h3>\n\n\n\n
In this guide, we will learn how to install self-hosted Novu. Here, we will use the easiest option- the docker option. You need to ensure that you have docker installed on your system. To achieve that, follow the below guides:<\/p>\n\n\n\n
- \n
- How to install Docker<\/a><\/li>\n<\/ul>\n\n\n\n
You also need to install docker-compose:<\/p>\n\n\n\n
- \n
- How to install Docker Compose<\/a><\/li>\n<\/ul>\n\n\n\n
Once installed, you also need to have
git<\/code><\/p>\n\n\n\n##On Debian\/Ubuntu\n<\/mark>sudo apt update && sudo apt install git\n\n##On Rhel-based Systems\n<\/mark>sudo yum install git<\/code><\/pre>\n\n\n\nYou need to ensure that you have a CPU with AVX support<\/strong> for MongoDB 5.0+.<\/p>\n\n\n\n
Clone the Novu Git Repo<\/h3>\n\n\n\n
The next thing is to clone the Novu repo:<\/p>\n\n\n\n
git clone https:\/\/github.com\/novuhq\/novu<\/code><\/pre>\n\n\n\nCreate a file with the environment variables:<\/p>\n\n\n\n
cd novu\/docker\ncp .env.example .\/local\/deployment\/.env<\/code><\/pre>\n\n\n\nConfigure the Environment Variables<\/h3>\n\n\n\n
You can now modify the .env file as desired:<\/p>\n\n\n\n
$ vim .\/local\/deployment\/.env<\/mark>\n Secrets\n# YOU MUST CHANGE THESE BEFORE GOING INTO PRODUCTION\nJWT_SECRET=your-secret\nSTORE_ENCRYPTION_KEY=\"<ENCRYPTION_KEY_MUST_BE_32_LONG>\"\n....<\/code><\/pre>\n\n\n\nGenerate and update your secrets in the file above. For this setup, all settings are simple as the database is in the same deployment and also uses local stack instead of S3 for storage.<\/p>\n\n\n\n
Run the Novu Containers<\/h3>\n\n\n\n
Once the desired changes have been made, you can start the container with the command:<\/p>\n\n\n\n
docker-compose -f .\/local\/deployment\/docker-compose.yml up -d<\/code><\/pre>\n\n\n\nCheck if the containers are up:<\/p>\n\n\n\n
$ docker ps<\/mark>\nCONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES\nb636eb05d497 ghcr.io\/novuhq\/novu\/embed:0.18.0 \"pnpm start:docker:e\u2026\" 4 minutes ago Up 4 minutes 0.0.0.0:4701->4701\/tcp, :::4701->4701\/tcp embed\n72587f77601c ghcr.io\/novuhq\/novu\/widget:0.18.0 \"pnpm start:static:w\u2026\" 4 minutes ago Up 4 minutes 0.0.0.0:4500->4500\/tcp, :::4500->4500\/tcp widget\n377d098ee36e ghcr.io\/novuhq\/novu\/web:0.18.0 \"docker-entrypoint.s\u2026\" 4 minutes ago Up 4 minutes 0.0.0.0:4200->4200\/tcp, :::4200->4200\/tcp web\ncb4c2551ef18 ghcr.io\/novuhq\/novu\/worker:0.18.0 \"pm2-runtime start d\u2026\" 4 minutes ago Up 4 minutes worker\n61564b1cffcb ghcr.io\/novuhq\/novu\/api:0.18.0 \"pm2-runtime start d\u2026\" 4 minutes ago Up 4 minutes 0.0.0.0:3000->3000\/tcp, :::3000->3000\/tcp api\n27b553d5f1d9 ghcr.io\/novuhq\/novu\/ws:0.18.0 \"docker-entrypoint.s\u2026\" 4 minutes ago Up 4 minutes 0.0.0.0:3002->3002\/tcp, :::3002->3002\/tcp ws\n3bcec428d86c mongo \"docker-entrypoint.s\u2026\" 4 minutes ago Up 11 seconds ago mongodb\n19bd436a6a63 redis:alpine \"docker-entrypoint.s\u2026\" 4 minutes ago Up 4 minutes 6379\/tcp redis<\/code><\/pre>\n\n\n\nStep 2. Access Novu Web Interface<\/h2>\n\n\n\n
You can now access the Novu web interface using the URL http:\/\/localhost:4200<\/a><\/p>\n\n\n\n
![\"\"](\"https:\/\/computingforgeeks.com\/wp-content\/uploads\/2023\/09\/Novu-open-source-notification-infrastructure-for-developers.png\" "\\"\\"")
<\/figure>\n\n\n\nCreate a New User<\/h3>\n\n\n\n
We need to create a new user by clicking on Sign Up<\/strong><\/p>\n\n\n\n
![\"\"](\"https:\/\/computingforgeeks.com\/wp-content\/uploads\/2023\/09\/Novu-open-source-notification-infrastructure-for-developers-2.png\" "\\"\\"")
<\/figure>\n\n\n\nCreate an Organization<\/h3>\n\n\n\n
Once the user has been created, you will be granted the below page. Create your own organization.<\/p>\n\n\n\n
![\"\"](\"https:\/\/computingforgeeks.com\/wp-content\/uploads\/2023\/09\/Novu-open-source-notification-infrastructure-for-developers-3.png\" "\\"\\"")
<\/figure>\n\n\n\nCreate a Provider<\/h3>\n\n\n\n
You will then be granted the Novu dashboard. Begin by creating your provider:<\/p>\n\n\n\n
![\"\"](\"https:\/\/computingforgeeks.com\/wp-content\/uploads\/2023\/09\/Novu-open-source-notification-infrastructure-for-developers-6.png\" "\\"\\"")
<\/figure>\n\n\n\nIn this guide, we will configure Email. You can still configure chat, SMS, In-App or SMS as desired. To configure Email, select the provider.<\/p>\n\n\n\n
![\"\"](\"https:\/\/computingforgeeks.com\/wp-content\/uploads\/2023\/09\/Novu-open-source-notification-infrastructure-for-developers-7.png\" "\\"\\"")
<\/figure>\n\n\n\nProvide the required details. For example, for outlook.<\/p>\n\n\n\n
![\"\"](\"https:\/\/computingforgeeks.com\/wp-content\/uploads\/2023\/09\/Novu-open-source-notification-infrastructure-for-developers-8.png\" "\\"\\"")
<\/figure>\n\n\n\nCreate a Workflow<\/h3>\n\n\n\n
After adding the provider, you can proceed and create the workflow.<\/p>\n\n\n\n
![\"\"](\"https:\/\/computingforgeeks.com\/wp-content\/uploads\/2023\/09\/Novu-open-source-notification-infrastructure-for-developers-9.png\" "\\"\\"")
<\/figure>\n\n\n\nProvide the name of the workflow.<\/p>\n\n\n\n
![\"\"](\"https:\/\/computingforgeeks.com\/wp-content\/uploads\/2023\/09\/Novu-open-source-notification-infrastructure-for-developers-10.png\" "\\"\\"")
<\/figure>\n\n\n\nNow modify your provider and the desired message to be triggered.<\/p>\n\n\n\n
![\"\"](\"https:\/\/computingforgeeks.com\/wp-content\/uploads\/2023\/09\/Novu-open-source-notification-infrastructure-for-developers-11.png\" "\\"\\"")
<\/figure>\n\n\n\nAfter clicking on it, you can make adjustments as desired<\/p>\n\n\n\n
![\"\"](\"https:\/\/computingforgeeks.com\/wp-content\/uploads\/2023\/09\/Novu-open-source-notification-infrastructure-for-developers-12.png\" "\\"\\"")
<\/figure>\n\n\n\nTest Novu by Triggering Notification<\/h3>\n\n\n\n
To test if Novu is working, we will trigger the notification by clicking on the icon shown, and the run the trigger.<\/p>\n\n\n\n
![\"\"](\"https:\/\/computingforgeeks.com\/wp-content\/uploads\/2023\/09\/Novu-open-source-notification-infrastructure-for-developers-13.png\" "\\"\\"")
<\/figure>\n\n\n\nIf all is okay, you will see this:<\/p>\n\n\n\n
![\"\"](\"https:\/\/computingforgeeks.com\/wp-content\/uploads\/2023\/09\/Novu-open-source-notification-infrastructure-for-developers-14.png\" "\\"\\"")
<\/figure>\n\n\n\nThe members subscribed will receive the notification as shown:<\/p>\n\n\n\n
![\"\"](\"https:\/\/computingforgeeks.com\/wp-content\/uploads\/2023\/09\/Novu-open-source-notification-infrastructure-for-developers-15-1024x525.png\" "\\"\\"")
<\/figure>\n\n\n\nVoila!<\/p>\n\n\n\n
Final Thoughts<\/h2>\n\n\n\n
We have learned how to install and use Novu – an open-source notification infrastructure for developers. You are now free to explore the other features provided by Novu by visiting the official Novu<\/a> page.<\/p>\n\n\n\n
Interested in more?<\/p>\n\n\n\n
- \n
- How To Run Mattermost Server in Docker Containers<\/a><\/li>\n\n\n\n
- GitLab and Slack Integration for notifications<\/a><\/li>\n\n\n\n
- Install Linen – Slack Alternative Searchable from Google<\/a><\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"
When developing applications and managing other resources within an environment. It is so vital to have a notification system. It makes it easier to notify and engage users and contributors in the project. Open-source notification tools allow developers to create notification systems that can be integrated into their environment. There are many notification systems some … Read more<\/a><\/p>\n","protected":false},"author":21,"featured_media":144998,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[690,299],"tags":[38782,38781],"class_list":["post-144753","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-dev","category-how-to","tag-notification-infrastructure","tag-novu"],"_links":{"self":[{"href":"https:\/\/computingforgeeks.com\/wp-json\/wp\/v2\/posts\/144753","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/computingforgeeks.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/computingforgeeks.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/computingforgeeks.com\/wp-json\/wp\/v2\/users\/21"}],"replies":[{"embeddable":true,"href":"https:\/\/computingforgeeks.com\/wp-json\/wp\/v2\/comments?post=144753"}],"version-history":[{"count":0,"href":"https:\/\/computingforgeeks.com\/wp-json\/wp\/v2\/posts\/144753\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/computingforgeeks.com\/wp-json\/wp\/v2\/media\/144998"}],"wp:attachment":[{"href":"https:\/\/computingforgeeks.com\/wp-json\/wp\/v2\/media?parent=144753"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/computingforgeeks.com\/wp-json\/wp\/v2\/categories?post=144753"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/computingforgeeks.com\/wp-json\/wp\/v2\/tags?post=144753"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
- GitLab and Slack Integration for notifications<\/a><\/li>\n\n\n\n
- How To Run Mattermost Server in Docker Containers<\/a><\/li>\n\n\n\n
- How to install Docker Compose<\/a><\/li>\n<\/ul>\n\n\n\n
- How to install Docker<\/a><\/li>\n<\/ul>\n\n\n\n