betchi207 / rtm-api

swagchat RTM API - Real Time Messaging API -

swagchat rtm-api

swagchat is an open source chat components for your webapps.

rtm-api is designed to be easy to introduce to your microservices as well.

Currently developing for version 1

Architecture

Related repositories

• Chat API
• SDK (TypeScript & JavaScript)
• UIKit (A set of React components)

Quick start

Just run the executable binary

You can download binary from Release page

# In the case of macOS (Default port is 9100)
./swagchat-rtm-api_darwin_amd64


# You can also specify the port
./swagchat-rtm-api_darwin_amd64 -port 9200

docker

docker run swagchat/rtm-api

Docker repository

Configuration

Specify the setting file (yaml format)

To override the default configuration options, make a copy of defaultConfig.yaml and then specify that file name in runtime parameter config and execute.

./rtm-api -config myConfig.yaml

Specify environment variables

You can overwrite it with environment variable.

export HTTP_PORT=80 && ./rtm-api

Specify runtime parameters

You can overwrite it with runtime parameters.

./rtm-api -httpPort 80

You can check the variables that can be set with the help command of the executable binary.

./rtm-api -h

License

MIT License.