Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/voipnorm/telehealthPresence
XMPP Video Endpoint Presence
https://github.com/voipnorm/telehealthPresence
Last synced: 3 months ago
JSON representation
XMPP Video Endpoint Presence
- Host: GitHub
- URL: https://github.com/voipnorm/telehealthPresence
- Owner: voipnorm
- License: mit
- Created: 2018-01-02T16:15:32.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-15T22:12:16.000Z (almost 6 years ago)
- Last Synced: 2024-07-07T00:41:18.698Z (4 months ago)
- Language: JavaScript
- Size: 2.4 MB
- Stars: 12
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-xapi - telehealthPresence - Add additional presence states for video endpoints in Jabber (by voipnorm). (Code Samples)
README
# Telehealth Presence Application
A mix of Webex Teams chatbot and XMPP application, TPA allows additional XMPP presence states for Cisco video codecs inside of a Jabber XMPP environment.
There are a number of components to this application:
* XMPP account registration for telehealth carts
* Webex Teams chat bot to do reporting and control of application(bulk uploads and application troubleshooting)
* Tracking availability of video endpoint administration pages to verify endpoint availability for enhanced presence status
* Poll video endpoints API for people presence and other information such as DND.
* Automatically update IP changes from CUCM using MAC information.
* MongoDB backend holds user, endpoint and space collections.
* Web admin interface for adding and removing users and endpoints.
* REST API service that allows administration and publish endpoint status.
All pieces work together to create an application that can add additional presence states for video endpoints similar to Cisco Movi.
[]
## Getting Started
The following applications and hardware are required:
* Cisco Unified Communications Manager
* Cisco Presence Server
* Cisco Video endpoint
* Cisco Webex Teams
* Nodejs
* MongoDb
### Prerequisites
Configuration required:
* Video endpoint registration in CUCM
* CUCM end user account enabled for Presence Server for each video endpoint
* Endpoint and end user accounts paired with each other within CUCM
* Cisco Webex Teams Bot account
* Cisco Webex Teams Space ID to send application messages.
* DNS FQDN videoPresence.:3001 eith via DNS record or host record.
* install and configure Nodejs and MongoDb
* Optional: MongoDb Compass
https://www.mongodb.com/download-center#compass
### Installing
#### Via Git
```bash
mkdir myproj
cd myproj
git clone https://github.com/voipnorm/telehealthPresence.git
npm install
```
Set the following environment variables...
```
SPARK_ROOM_ID=
SPARK_BOT=
WEBPORT=8080
NODE_ENV=development
SPARK_BOT_STRING=
ALLOW_DOMAIN=
APP_ADMIN=
XMPPSERVER=
XMPPCARTPWD=
TPADMIN=
TPADMINPWD=
SECRETTOKEN=
WEBADMIN=
WEBADMINPWD=
WEBADMINTOKEN=
CUCMPRESENCEACCOUNT=
CUCMPRESENCEPWD=
CUCMIPADDRESS=
CUCMVERSION=
```
Despcription of variables:
* SPARK_ROOM_ID => Webex Teams room ID used for error notification and and system messages
* SPARK_BOT => Bot token used for direct interaction with application bot. Bot command capable.
* WEBPORT => port used by flint framework to create websocket with Spark service.
* NODE_ENV => development or production
* SPARK_BOT_STRING => String used to identify bot in @ mentions from Spark
* ALLOW_DOMAIN => security setting to define your companies domain.
* APP_ADMIN => admins Webex Teams ID
* XMPPSERVER => XMPP/CUPS server ip address
* XMPPCARTPWD => admin password for telehealth cart. Can also be specified in cart.json
##Generate Local CA Certificates using OpenSSL:
```
openssl genrsa -out localhost.key 2048
openssl req -new -x509 -key localhost.key -out localhost.cert -days 3650 -subj /CN=localhost
```
#Node alternate configuration for https:
```
var options = {
key: fs.readFileSync( './localhost.key' ),
cert: fs.readFileSync( './localhost.cert' ),
requestCert: false,
rejectUnauthorized: false
};
```
## Built With
* [node-flint](https://github.com/flint-bot/flint) - The bot framework used
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
## Acknowledgments
* Nick Marus node-flint creator.
## Flint Support
Chat with us here:[flint-support](https://eurl.io/#rkwLEq4fZ)