> For the complete documentation index, see [llms.txt](https://lern.sunbird.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://lern.sunbird.org/use/developer-guide/notification-service/developer-installation/installation-guide.md).

# Installation Guide

### How To Setup

Please refer to the github readme document.

{% embed url="<https://github.com/sunbird-lern/sunbird-notification-service/blob/master/README.md>" %}

### **Installation Configuration:**

Notification service requires few configurations to be set in properties file. Some of these properties can also be set as environment variables.

{% embed url="<https://github.com/sunbird-lern/sunbird-notification-service/tree/release-4.5.0/sb-utils/src/main/resources>" %}

{% embed url="<https://github.com/sunbird-lern/sunbird-notification-service/tree/master/notification-sdk/src/main/resources>" %}

Cassandra Migration in sunbird-utils needs to be run before notification service run to create necessary table required by the notification service.

Database details need to be configured in [cassandra.config.properties](https://github.com/sunbird-lern/sunbird-notification-service/blob/release-4.5.0/sb-utils/src/main/resources/cassandra.config.properties) file.

There is no dependency when sending notifications in sync mode. But while sending async notifications, application needs notification flink job to run. This need to be setup along with kafka.

Repository for sunbird jobs(Before 5.0.0): <https://github.com/project-sunbird/sunbird-lms-jobs>

Repository for sunbird jobs(After 5.0.0): <https://github.com/Sunbird-Lern/data-pipeline/tree/master/lms-jobs>

**Steps for setting up notification flink job:**

<https://github.com/Sunbird-Lern/data-pipeline/blob/master/README.md>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://lern.sunbird.org/use/developer-guide/notification-service/developer-installation/installation-guide.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.