postman

README

postman

easy pub/sub messaging server using websocket.

Application Options:

• -p, --port: listen port number (default: 8800)
• -l, --log: output log location
• -c, --chlist: safelist for channels
• -i, --iplist: connectable ip_address list
• -k, --store: enable key-value store api
• -f, --file: enable file server api
• -u, --plugin: enable plugin api
• -s, --secure: enable secure mode
• -g, --generate: genarate token from environment variable [SECRET]

Help Options:

• -h, --help: Show this help message

Websocket API

• Ping
  • <- "ping {}"
• Status
  • <- "status {}"
• Subscribe
  • <- "subscribe {"ch": "CHANNEL", ["ci": "CLIENT_INFO"]}"
• Unsubscribe
  • <- "unsubscribe {"ch": "CHANNEL"}"
• Publish
  • <- "publish {"ch": "CHANNEL", "msg": "MESSAGE", ["tag": "TAG", "ext": "OTHER"]}"

Http API

http://XXX.XXX.XXX.XXX:8800/postman

• Status
  • (GET) /status
  • (GET) /status_pp
• Publish
  • (GET) /publish?ch=CHANNEL&msg=MESSAGE[&tag=TAG&ext=OTHER&ci=CLIENT_INFO]
  • (POST) /publish <- json={"ch": "CHANNEL", "msg": "MESSAGE", ["tag": "TAG", "ext": "OTHER", "ci": "CLIENT_INFO"]}
• Store
  • (GET) /store?cmd=(GET|SET|HAS|DEL)&key=KEY[&val=VALUE]
  • (POST) /store <- json={"cmd": "(GET|SET|HAS|DEL)", "key": "KEY", ["val": "VALUE"]}
• File
  • (GET) /file?name=FILE_NAME
  • (POST) /file <- file=FILE_BINARY
• Plugin
  • (GET) /plugin?cmd=COMMAND
  • (POST) /plugin <- json={"cmd": "COMMAND"}
  • see ./plugin/plugin.json

Client Library

• Unity
  • require
    • websocket-sharp.dll
    • Json.NET for Unity
    • UniTask
• js
• python

Build Tags for Windows

$ go build -tags windows ./... others $ go build ./...

Using on PaaS

change code in main.go.

TARGET_PAAS = true

and deploy.