@tsadda25/redx-backend-client/README.md

Redx backend client for auto registration of services

<img src="https://webadmin.promfacility.eu/uploads/018e8a986030489ea5fc97190e124277.png" alt="RedX Logo" width="150px">

## Backend registration client

This is the node module for auto registration of backend services
to RedX server.

[RedX Server](https://github.com/adda25/redx)

```js
let redxRegisterRequest = require('@tsadda25/redx-backend-client')

redxRegisterRequest({ 
	src: 'http://localhost:8283', // Redx host
	service: {host: '192.168.1.1', port: 4003, protocol: 'http'},
	secret: '21137818784737',
	repeat: false, // default, doesn't repeat the request
	repeatTime: 10000 // default, repeat interval in ms if repeat is true
}, (value) => {
	// True if registration success, otherwise false
	console.log(value)
})
```

For the source, you must use the URL as show: protocol[://]host[:]port.
You can register to multiple RedX server passing an array of src: 

```js
let redxRegisterRequest = require('@tsadda25/redx-backend-client')

redxRegisterRequest({ 
	src: ['http://srv01.local:8283', 'http://srv02.local:8283'], // Redx host
	service: {host: '192.168.1.1', port: 4003, protocol: 'http'},
	secret: '21137818784737'
}, (value) => {
	// True if registration success, otherwise false
	console.log(value)
})
```

Secret can be undefined; service.host and service.protocol can be undefined.

Availables protocols are *http* and *https*

If no service host is provided, RedX server will try to get the service IP address
from the request info.

```js
let redxRegisterRequest = require('@tsadda25/redx-backend-client')

redxRegisterRequest({ 
	src: 'http://localhost:8283', // Redx host
	service: {port: 4003},
	secret: '21137818784737'
}, (value) => {
	// True if registration success, otherwise false
	console.log(value)
})
```

### Registration loop

If the repeat option is set to *true*, the module will send a registration request every *repeatTime* milliseconds,
the default interval value is 10000ms (10s).