@showbridge/cloud
v0.5.0
Published
Cloud server for proxying messages between showbridge instances
Downloads
20
Maintainers
Readme
Usage
Source
npm install
add and configure a .env
file if you would like to provide any of the environment variables below.
npm start
Docker
docker build -t showbridge-cloud .
docker run -p 8888:8888 showbridge-cloud
NPX
npx @showbridge/cloud
Environment Variables
LOG_LEVEL
(optional): log level to pass to pino logger i.e 10, 20, 30, etc.PORT
(optional): the port to run on defuault: 8888ADMIN_UI_USERNAME
(optional): Username for the admin uiADMIN_UI_PASSWORD
(optional): Password for the admin uiREDIS_URL
(optional): redis client url for socket.io redis-streams adapter if no url is provided then socket.io starts up as a solo instanceDISCORD_WEBHOOK_URL
(optional): discord webhook url to send some status messages toDISCORD_EVENTS
(optional): comma separated list of events to send to the configured discord webhook- events:
connect
,disconnect
,leave
,join
(defaults to all)
- events:
Info
- admin ui available at
/ui
- server ready endpoint at
/ready
return 200 when server is up and running, 503 while starting up for use in things like k8s readinessProbe