# Self-host Notifiarr

> Client for the Notifiarr service that relays notifications and syncs profiles for your media apps. The install form carries notifiarr.conf as an editable file and asks for your API key.

- Page: https://levelrail.com/templates/notifiarr/
- JSON: https://levelrail.com/templates/notifiarr.json
- Category: Media
- Licence: MIT (Permissive license)
- Source: https://github.com/Notifiarr/notifiarr
- Upstream docs: https://notifiarr.wiki/

## Requirements
- Memory: about 128 MiB
- amd64: unknown, arm64: unknown
- Needs configuration before start: yes
- Pinned image tag: v0.10.0

## Services

| Service | Image | Tag | Ports | Volumes |
| --- | --- | --- | --- | --- |
| notifiarr | ghcr.io/notifiarr/notifiarr | v0.10.0 | 5454 | config -> /config |

## Deploy

### CLI

```bash
levelrail-cli templates install notifiarr --name my-notifiarr --env NOTIFIARR_API_KEY=VALUE
```

Add --domain SERVICE=HOST to serve a service on your own domain, for example --domain notifiarr=app.example.com.

### API

```bash
curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  https://levelrail.example.com/api/v1/service-templates/notifiarr/install \
  -d '{
    "name": "my-notifiarr",
    "env": { "NOTIFIARR_API_KEY": "VALUE" }
  }'
```

Create a token in the dashboard first. Name, env and domains are the request fields.

## First run
1. Create an account on notifiarr.com, copy your API key into the install form, then open the address to add your apps.

## Questions

### Can I deploy Notifiarr on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list we compared does not have an entry with the same id for Notifiarr, so on Dokploy you would use a Docker Compose application with the file from this page. Dokku deploys container images with its own commands, so the pinned image ghcr.io/notifiarr/notifiarr:v0.10.0 is what you deploy there.

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