Skip to content

Service start

Klervi edited this page Jul 19, 2019 · 3 revisions


Start on Windows

In the ~/bots folder, open a terminal and run:

./framework/start.bat -bot mybot -env dev MyBotApp

The complete command line is:

./start.bat [ -port port ] [ -host http://host.url ] [ -bot botfoldername ] [ -env dev|quali|prod ] [ -log pathtologs ] [ -cred passphrase ] [ -ui nodereduiroute]

The expected arguments are:

  • port: the local port on which the service will run, default 1880
  • host: the server url to access your service, default in bot/conf/config.js
  • bot: the name of your bot folder
  • env: your environment, will be used to select your credentials file
  • log path: location of pm2 logs
  • node red route: the route on which the UI will be available, default /
  • credential secret: your secret for credential encryption (used when the Node-RED projects feature is disabled)

Start on Linux

In your root folder, launch the process:

cd ~/bots
./framework/start.sh --bot mybot --env dev MyBotApp

You will get the output:

The complete command line is:

bash start.sh [ -p port ] [ --url http://url ] [ --docker ] --bot [ botfoldername ] --env [ dev|quali|prod ] [ --log-path pathtologs ] [ --credential-secret passphrase ] [ --no-credential-split ] [--node-red-route aRoute ] app

The expected arguments are:

  • port: the local port on which the service will run, default 1880
  • url: the server url to access your service, default in bot/conf/config.js
  • docker: if the process is running inside a docker container, default false
  • bot: the name of your bot folder
  • env: your environment, will be used to select your credentials file
  • log path: location of pm2 logs
  • node red route: the route on which the UI will be available, default /
  • credential secret: your secret for credential encryption (used when the Node-RED projects feature is disabled)
  • no credential split : prevent the separation of credential files according to NODE_ENV