tnpg

README

TNPG: Push Gateway

This is push notifications adapter which communicates with Tinode Push Gateway (TNPG).

TNPG is a proprietary service intended to simplify deployment of on-premise installations. Deploying a Tinode server without TNPG requires configuring Google FCM with your own credentials including recompiling mobile clients and releasing them to PlayStore and AppStore under your own accounts which is usually time consuming and relatively complex.

TNPG solves this problem by allowing you to send push notifications on behalf of Tinode. Internally it uses Google FCM and as such supports the same platforms as FCM. The main advantage of using TNPG over FCM is simplicity of configuration: mobile clients do not need to be recompiled, all is needed is a configuration update on the server.

Configuring TNPG adapter

Obtain TNPG token

1. Register at https://console.tinode.co and create an organization.
2. Get the TPNG token from the On premise section by following the instructions there.

Configure the server

Update the server config tinode.conf, section "push" -> "name": "tnpg":

{
  "enabled": true,
  "org": "myorg", // name of the organization you registered at console.tinode.co
  "token": "SoMe_LonG.RaNDoM-StRiNg.12345" // authentication token obtained from console.tinode.co
}

Make sure the fcm section is disabled "enabled": false.

Documentation

Overview

Package tnpg implements push notification plugin for Tinode Push Gateway.

Index

• type Handler
  • func (Handler) Init(jsonconf string) error
  • func (Handler) IsReady() bool
  • func (Handler) Push() chan<- *push.Receipt
  • func (Handler) Stop()

Types

type Handler

type Handler struct {
	// contains filtered or unexported fields
}

func (Handler) Init

func (Handler) Init(jsonconf string) error

Init initializes the handler

func (Handler) IsReady

func (Handler) IsReady() bool

IsReady checks if the handler is initialized.

func (Handler) Push

func (Handler) Push() chan<- *push.Receipt

Push returns a channel that the server will use to send messages to. If the adapter blocks, the message will be dropped.

func (Handler) Stop

func (Handler) Stop()

Stop terminates the handler's worker and stops sending pushes.