Skip to content

Commit 2c3be45

Browse files
committed
Documentation update
1 parent e7c803d commit 2c3be45

File tree

2 files changed

+12
-9
lines changed

2 files changed

+12
-9
lines changed

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,15 @@
22

33
![A chat window in Mattermost showing the chat between the OpenAI bot and "yGuy"](./mattermost-chat.png)
44

5-
Here's how to get the bot running - it's easy if you have a Docker server.
5+
The bot can talk to you like a regular mattermost user. It's like having chat.openai.com built collaboratively built into Mattermost!
6+
But that's not all, you can also use it to generate images via Dall-E or diagram visualizations via a yFiles plugin!
7+
8+
Here's how to get the bot running - it's easy if you have a Docker host.
69

710
You need
811
- the [Mattermost token](https://docs.mattermost.com/integrations/cloud-bot-accounts.html) for the bot user (`@chatgpt` by default)
912
- the [OpenAI API key](https://platform.openai.com/account/api-keys)
10-
- a [Docker](https://www.docker.com/) server for continuously running the service, alternatively for testing, Node.js is sufficient.
13+
- a [Docker](https://www.docker.com/) server for continuously running the service, alternatively for testing, Node.js 16 is sufficient.
1114

1215
Andrew Zigler from Mattermost created a [YouTube Video](https://www.youtube.com/watch?v=Hx4Ex7YZZiA) that quickly guides you through the setup.
1316

@@ -17,7 +20,7 @@ If you want to learn more about how this plugin came to live, [read the blog pos
1720
## Options
1821

1922
These are the available options, you can set them as environment variables when running [the script](./src/botservice.ts)
20-
or when [running the docker image](#using-the-ready-made-image) or when configuring your [docker-compose](#docker-compose) file.
23+
or when [running the docker image](#using-the-ready-made-docker-image) or when configuring your [docker-compose](#docker-compose) file.
2124

2225
| Name | Required | Example Value | Description |
2326
|----------------------|----------|------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -40,7 +43,7 @@ or when [running the docker image](#using-the-ready-made-image) or when configur
4043
> [LinkedIn Post](https://www.linkedin.com/posts/yguy_chatgpt-yfiles-diagramming-activity-7046713027005407232-2bKH)
4144
> If you are interested in getting your hands on the plugin, please contact [yWorks](https://www.yworks.com)!
4245
43-
## Using the ready-made image
46+
## Using the ready-made Docker image
4447

4548
Use the prebuilt image from [`ghcr.io/yguy/chatgpt-mattermost-bot`](https://ghcr.io/yguy/chatgpt-mattermost-bot)
4649

@@ -53,17 +56,17 @@ docker run -d --restart unless-stopped \
5356
ghcr.io/yguy/chatgpt-mattermost-bot:latest
5457
```
5558

56-
## Building the docker image yourself
59+
## Building the Docker image manually
5760

5861
First step is to clone this repo.
5962

6063
```bash
6164
git clone https://github.com/yGuy/chatgpt-mattermost-bot.git && cd chatgpt-mattermost-bot
6265
```
6366

64-
For testing, you could now just run `npm install` and `npm run start` or `node src/botservice.js` directly, but be sure to set the [environment variables](#options) or pass them to the node process, first!
67+
For testing, you could now just run `npm install` and `npm run start` directly, but be sure to set the [environment variables](#options) or pass them to the node process, first!
6568

66-
For production use, in order to create a service on a docker container that will always provide the service without you having to run it on your own PC, you can do the following:
69+
For production use, in order to create a service on a docker container that will always provide the service without you having to run it on your own machine, you can do the following:
6770

6871
Build the docker image from the [Dockerfile](./Dockerfile):
6972
```bash
@@ -145,7 +148,7 @@ services:
145148
NODE_EXTRA_CA_CERTS: /certs/certfile.crt
146149
```
147150

148-
### Run the container as a daemon
151+
### Run the container as a service
149152
When all configuration is complete, start the container service.
150153
```bash
151154
docker compose up -d
@@ -178,4 +181,4 @@ I will also accept helpful pull requests if you find an issue or have an idea fo
178181

179182
Last but not least, check out [yWorks](https://www.yworks.com)' fine diagramming SDKs for software developers [yFiles](https://yworks.com/yfiles) and our [free online graph and diagram editors](https://yworks.com/editors)!
180183

181-
This is under MIT license Copyright (c) 2023 Sebastian Mueller and Michael Haeglsperger (yWorks)
184+
This is under MIT license Copyright (c) 2023 Sebastian Mueller (yWorks) and Michael Haeglsperger (yWorks)

mattermost-chat.png

-122 KB
Loading

0 commit comments

Comments
 (0)