Skip to content

Commit 38db021

Browse files
author
Mike Holloway
committed
update docs for using local plugins and backends
1 parent e6c3a43 commit 38db021

File tree

1 file changed

+6
-11
lines changed

1 file changed

+6
-11
lines changed

README.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,28 +18,21 @@ To simply deploy Errbot in interactive _Text_ mode:
1818
cd /usr/local/src
1919
git clone https://github.com/swarmstack/errbot-docker
2020
cd errbot-docker
21-
docker run -it swarmstack/errbot-docker:latest
21+
docker run -it swarmstack/errbot-docker
2222
```
2323

2424
---
2525

2626
## RUN ERRBOT AS A DETACHED CONTAINER
2727

28-
To expose the Errbot webhook network port and connect Errbot to your chosen, you'll need to configure your social network of choice as the BACKEND in config.py and also any parameters that backend requires (generally in the form of BOT_CONFIG values) before starting the bot. Refer to the Errbot [User Guide](http://errbot.io/en/latest/user_guide/setup.html#id1) for parameters required for your specific built-in Errbot backend.
28+
To expose the Errbot webhook network port and connect Errbot to your configured backend social network, set BACKEND in config.py and also any parameters that backend requires (generally in the form of BOT_CONFIG values) before starting the bot. Refer to the Errbot [User Guide](http://errbot.io/en/latest/user_guide/setup.html#id1) for parameters required for your specific built-in Errbot backend, or the section below for Cisco Webex Teams users.
2929

3030
```
3131
vi config.py
32-
docker run -d --entrypoint errbot -p 3141:3141 -v `pwd`:/err/local_config swarmstack/errbot-docker:latest -c /err/local_config/config.py
32+
docker run -d --entrypoint errbot -p 3141:3141 -v `pwd`:/err/local_config \
33+
swarmstack/errbot-docker -c /err/local_config/config.py
3334
```
3435

35-
You can also add any local_plugins or local_backends to those directories before deploying above, although it's recommended to instead install plugins as documented in the CONFIGURATION section where possible (they will be persisted within the /err/data Docker bind volume when running as a stack). Make the following change to config.py:
36-
37-
BOT_EXTRA_PLUGIN_DIR = r'/err/local_config/local_plugins'
38-
39-
If you need to install a custom backend, add and remove necessary local_backends directories and then change config.py to:
40-
41-
BOT_EXTRA_BACKEND_DIR = r'/err/local_config/local_backends'
42-
4336
---
4437

4538
## RUN ERRBOT AS A STACK ON A DOCKER SWARM HOST
@@ -54,6 +47,8 @@ vi docker-compose.yml
5447
docker stack deploy -c docker-compose.yml errbot
5548
```
5649

50+
---
51+
5752
## ADDING YOUR OWN BACKEND
5853

5954
You can also add any local_plugins or local_backends to those directories before deploying above, although it's recommended to instead install plugins as documented in the CONFIGURATION section where possible; this way they will be persisted within the /err/data Docker volume.

0 commit comments

Comments
 (0)