Awesome

intercom-manager

Open Source Intercom Solution

Intercom solution powered by Symphony Media Bridge. This is the Intercom manager API microservice.

Requirements

A Symphony Media Bridge running and reachable
A MongoDB server or CouchDB server
Docker engine

Environment variables

Variable name	Description
`PORT`	Intercom-Manager API port
`SMB_ADDRESS`	The address:port of the Symphony Media Bridge instance
`SMB_APIKEY`	When set, provide this API key for the Symphony Media Bridge (optional)
`DB_CONNECTION_STRING`	DB connection string (default: `mongodb://localhost:27017/intercom-manager`)
`MONGODB_CONNECTION_STRING`	DEPRECATED: MongoDB connection string

Installation / Usage

Start an Intercom Manager instance:

docker run -d -p 8000:8000 \
  -e PORT=8000 \
  -e SMB_ADDRESS=http://<smburl>:<smbport> \
  -e DB_CONNECTION_STRING=<mongodb|http>://<host>:<port>/<db-name> \
  eyevinntechnology/intercom-manager

The API docs is then available on http://localhost:8000/api/docs/

Development

Requires Node JS engine >= v18 and MongoDB (tested with MongoDB v7) or CouchDB.

Install dependencies

npm install

Run tests

npm test

Start server locally

SMB_ADDRESS=http://<smburl>:<smbport> SMB_APIKEY=<smbapikey> npm start

See Environment Variables for a full list of environment variables you can set. The default DB_CONNECTION_STRING is probably what you want to use for local development unless you use a remote db server.

Terraform infrastructure

Requires terraform and AWS access

cd infra
terraform init -var-file="dev.tfvars"

Development workspace

Create or select workspace dev

cd infra
terraform workspace new dev

cd infra
terraform workspace select dev

Create resources with variables for dev environment

terraform plan -var-file="dev.tfvars"
terraform apply -var-file="dev.tfvars"

Production workspace

Create or select workspace prod

cd infra
terraform workspace select prod

terraform plan -var-file="prod.tfvars"
terraform apply -var-file="prod.tfvars"

Contributing

See CONTRIBUTING

Support

Join our community on Slack where you can post any questions regarding any of our open source projects. Eyevinn's consulting business can also offer you:

Further development of this component
Customization and integration of this component into your platform
Support and maintenance agreement

Contact sales@eyevinn.se if you are interested.

About Eyevinn Technology

Eyevinn Technology is an independent consultant firm specialized in video and streaming. Independent in a way that we are not commercially tied to any platform or technology vendor. As our way to innovate and push the industry forward we develop proof-of-concepts and tools. The things we learn and the code we write we share with the industry in blogs and by open sourcing the code we have written.

Want to know more about Eyevinn and how it is to work here. Contact us at work@eyevinn.se!