2017-07-18 00:01:54 -04:00
|
|
|
```
|
2018-05-31 03:26:11 -04:00
|
|
|
zulip-botserver --config-file <path to botserverrc> --hostname <address> --port <port>
|
2017-07-18 00:01:54 -04:00
|
|
|
```
|
|
|
|
|
|
2018-05-31 03:26:11 -04:00
|
|
|
Example: `zulip-botserver --config-file ~/botserverrc`
|
2017-07-18 00:01:54 -04:00
|
|
|
|
|
|
|
|
This program loads the bot configurations from the
|
2021-01-07 03:17:03 -05:00
|
|
|
config file (`botserverrc`, here) and loads the bot modules.
|
2017-07-18 00:01:54 -04:00
|
|
|
It then starts the server and fetches the requests to the
|
|
|
|
|
above loaded modules and returns the success/failure result.
|
|
|
|
|
|
2021-01-07 03:17:03 -05:00
|
|
|
The `--hostname` and `--port` arguments are optional, and default to
|
|
|
|
|
127.0.0.1 and 5002 respectively.
|
|
|
|
|
|
|
|
|
|
The format for a configuration file is:
|
|
|
|
|
|
|
|
|
|
[helloworld]
|
|
|
|
|
key=value
|
|
|
|
|
email=helloworld-bot@zulip.com
|
|
|
|
|
site=http://localhost
|
|
|
|
|
token=abcd1234
|
|
|
|
|
|
|
|
|
|
Is passed `--use-env-vars` instead of `--config-file`, the
|
|
|
|
|
configuration can instead be provided via the `ZULIP_BOTSERVER_CONFIG`
|
|
|
|
|
environment variable. This should be a JSON-formatted dictionary of
|
|
|
|
|
bot names to dictionary of their configuration; for example:
|
|
|
|
|
|
|
|
|
|
ZULIP_BOTSERVER_CONFIG='{"helloworld":{"email":"helloworld-bot@zulip.com","key":"value","site":"http://localhost","token":"abcd1234"}}' \
|
|
|
|
|
zulip-botserver --use-env-vars
|
