# Notifications configuration

Use this page to understand notification service and email notification fields for Ripple Custody. The example shows one possible configuration shape; SMTP provider, credentials, resource values, scaling, and delivery policy depend on your deployment.

This page applies to on-premise deployments only. For current defaults and the full supported schema, use the configuration packaged with your release.

## What this config controls

The notification system handles notification processing, persistence, real-time delivery, and optional email delivery. Email notification settings are configured under `harmonize.notifications.email`. The notification service component is configured under `components.notification`.

## Email fields

Location: `harmonize.notifications.email`

| Parameter | Type | Default | Description |
|  --- | --- | --- | --- |
| `enabled` | boolean | `false` | Enables email notifications. |
| `sender` | string | `harmonize@example.com` | Sender address for email notifications. |
| `smtp.host` | string | `smtp.example.com` | SMTP server hostname. |
| `smtp.port` | string | `"25"` | SMTP server port. Common values: `25`, `465`, `587`, `2525`. |
| `smtp.username` | string | - | SMTP authentication username. |
| `smtp.password` | string | - | SMTP authentication password. Store through your secret-management process. |


SMTP port notes:

| Port | Protocol |
|  --- | --- |
| `25` | SMTP |
| `465` | SMTPS |
| `587` | SMTP with STARTTLS |
| `2525` | SMTP with STARTTLS |


## Notification component fields

Location: `components.notification`

| Field | Description |
|  --- | --- |
| `enabled` | Enables the notification component. |
| `image.repository` | Notification service image repository. |
| `image.tag` | Notification service image tag. |
| `replicas` | Number of notification service replicas. |
| `resources.requests` | CPU and memory requests. |
| `resources.limits` | CPU and memory limits. |
| `service.main.ports.http.port` | Service HTTP port. |
| `service.main.ports.http.targetPort` | Container target port. |
| `autoscaling` | Horizontal autoscaling settings, where exposed by your release. |


Resource and replica values are workload-dependent. Set them based on expected notification volume and observed runtime behavior.

## Environment variables

| Variable | Description | Example or source |
|  --- | --- | --- |
| `LOG_LEVEL` | Notification service log level. | `info`, `debug`, `warn`, `error` |
| `POSTGRES_URL` | PostgreSQL connection string. | Secret |


OAuth credentials, database schema, and inter-service URLs are managed by the deployment configuration unless explicitly exposed.

## Notification templates

The notification service uses built-in templates for notification categories such as transaction updates, approval requests, security alerts, system notifications, and custom application notifications.

## Constraints and relationships

- Email notifications require SMTP connection details.
- SMTP credentials should be supplied through your secret-management process.
- Notification persistence requires PostgreSQL connectivity.
- Event-driven notification processing depends on AMQP configuration.
- Notification APIs depend on OAuth authentication configuration.


## Example

This example shows email notification settings and the notification component in one deployment values file:


```yaml
harmonize:
  notifications:
    email:
      enabled: true
      sender: "noreply@example.com"
      smtp:
        host: "smtp.example.com"
        port: "587"
        username: "<smtp-user>"
        password: "<smtp-password>"

components:
  notification:
    enabled: true
    replicas: 1
    resources:
      limits:
        cpu: 1000m
        memory: 1024Mi
      requests:
        cpu: 100m
        memory: 256Mi
    service:
      main:
        ports:
          http:
            port: 80
            targetPort: 3000
```

## Related topics

- [OAuth server configuration](/products/custody/v1.36/deployment/reference/oauth-server)
- [AMQP configuration](/products/custody/v1.36/deployment/reference/amqp)
- [Networking configuration](/products/custody/v1.36/deployment/reference/networking)
- [PostgreSQL configuration](/products/custody/v1.36/deployment/reference/postgresql)