Running an SXAPI application user guide

Run container version

To start your default application using sxapi container you should run the following command

docker run startx/sxapi

For more information on how to use this project as a container, see use docker image

Run NPM module version

To start your default application using sxapi npm module you should run the following command

node app.js

For more information on how to use this project as a npm module, see use npm module

Requirements

SXAPI CWS (sxapi-cws)

Github account

server config

Download project

Github config

Storage

Network

Build service

docker-compose build

Start service

You must start your service with a daemonized (-d) version. This way you could later this container gracefully rather than sending a brutal SIGKILL

docker-compose up -d

Stop service

If you stop your container, sxapi application will be shutdown gracefully. All resources and connections established by you instance will be closed before exit.

docker-compose stop

Kill service

When killing you container, docker send a SIGKILL signal to the container. This signal cause termination of the process, making it impossible to capture and make a clean stop of the server. You should avoid killing your container and prefer the operation of stopping and removing them.

docker-compose kill
# or better
docker-compose stop && docker-compose rm

test service

wget http://localhost:8077/