> For the complete documentation index, see [llms.txt](https://docs.noctrastore.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.noctrastore.net/noctra-notify/installation.md).

# Installation

Install Noctra Notify and make it available to your resources.

Noctra Notify has no framework, database, or third-party dependency.

## Setup

{% stepper %}
{% step %}

### Add the resource

Place the downloaded folder inside your resources directory and keep its name as:

```
noctra_notify
```

The documented exports use this resource name.
{% endstep %}

{% step %}

### Start Noctra Notify

Add it to `server.cfg` before resources that use its exports:

```cfg
ensure noctra_notify
ensure your_dependent_resource
```

{% endstep %}

{% step %}

### Select the default positions

Open `config.lua` and choose whether notification and Text UI positions should be forced globally or selected by each call.

```lua
Config.ForcePosition = 'center-right'
Config.ForceTextPosition = 'right'
```

Set either option to `false` to respect the position sent by the calling resource.
{% endstep %}

{% step %}

### Test the resource

Call a notification from a client resource:

```lua
exports.noctra_notify:Notify({
    type = 'success',
    title = 'Noctra Notify',
    message = 'The resource is ready.'
})
```

If another notification or Text UI resource is being replaced, move its calls to Noctra Notify before disabling it.
{% endstep %}
{% endstepper %}

## Optional framework integration

Direct exports are recommended for individual resources. To make framework helper functions use Noctra Notify automatically, follow the framework integration guide.

{% content-ref url="/pages/k0wfiJLZTqvQx9hviigK" %}
[Framework integration](/noctra-notify/framework-integration.md)
{% endcontent-ref %}


---

# 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://docs.noctrastore.net/noctra-notify/installation.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.