https://github.com/swagchat/rtm-api
swagchat RTM API - Real Time Messaging API -
https://github.com/swagchat/rtm-api
chat docker golang messaging microservice realtime-messaging
Last synced: 12 months ago
JSON representation
swagchat RTM API - Real Time Messaging API -
- Host: GitHub
- URL: https://github.com/swagchat/rtm-api
- Owner: swagchat
- License: mit
- Created: 2017-06-29T12:07:47.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-12-26T09:23:12.000Z (over 7 years ago)
- Last Synced: 2025-03-25T07:51:07.507Z (about 1 year ago)
- Topics: chat, docker, golang, messaging, microservice, realtime-messaging
- Language: Go
- Homepage:
- Size: 42.6 MB
- Stars: 2
- Watchers: 4
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](LICENSE)
[](https://goreportcard.com/report/github.com/swagchat/rtm-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](https://github.com/swagchat/chat-api)
* [SDK (TypeScript & JavaScript)](https://github.com/swagchat/swagchat-sdk-js)
* [UIKit (A set of React components)](https://github.com/swagchat/react-swagchat)
## Quick start
### Just run the executable binary
You can download binary from [Release page](https://github.com/swagchat/rtm-api/releases)
```
# 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](https://hub.docker.com/r/swagchat/rtm-api/)
## 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.