Notification Relay Service

A service for managing web push notifications across multiple projects using Firebase Cloud Messaging (FCM).

Features

• Multi-project support with separate Firebase configurations
• Topic-based notifications
• User-specific notifications
• Customizable notification decorations
• Icon management
• Secure API authentication
• Docker support

Installation Methods

Easy Install (Binary)

Installs the latest release binary as a system service:

curl -sSL https://raw.githubusercontent.com/metalmon/notification-relay/main/install-binary.sh | sudo bash

After installation:

1. Configure your Firebase settings:

   sudo nano /etc/notification-relay/config.json

2. Add your service account key:

   sudo cp path/to/service-account.json /etc/notification-relay/

3. Start the service:

   sudo systemctl start notification-relay
   sudo systemctl enable notification-relay

Production Install (Docker + System Service)

Full production installation with Docker support:

curl -sSL https://raw.githubusercontent.com/metalmon/notification-relay/main/install.sh | sudo bash

This method:

• Sets up Docker containers
• Creates system service
• Configures logging
• Sets up proper permissions
• Provides production-ready deployment

Documentation

• Configuration Guide - Detailed configuration instructions
• Firebase Setup Guide - How to set up Firebase and generate VAPID keys
• API Documentation - API endpoints and usage
• Decoration Guide - Notification decoration configuration
• Icons Guide - Icon configuration and usage

Configuration Files

• config.json - Main configuration file (required)
• credentials.json - API credentials (auto-generated)
• decoration.json - Notification decoration rules
• topic-decoration.json - Topic-specific decoration rules
• icons.json - Project icon paths
• user-device-map.json - User device token mapping (auto-generated)

Environment Variables

• NOTIFICATION_RELAY_CONFIG - Path to config.json
• GOOGLE_APPLICATION_CREDENTIALS - Path to service account JSON
• LISTEN_PORT - Server port (default: 5000)
• TRUSTED_PROXIES - Trusted proxy CIDR ranges

Security Considerations

1. Always use HTTPS in production
2. Configure trusted proxies appropriately
3. Keep service account and VAPID keys secure
4. Use strong API credentials
5. Set appropriate file permissions

License

MIT License