mono/packages/kbot/docs/docker.md
2025-04-07 18:52:59 +02:00

58 lines
948 B
Markdown

# Docker Usage
## Quick Start
To quickly get started with kbot using Docker, run:
```bash
docker run -d -p 8080:8080 plastichub/kbot
```
This command:
- Runs the container in detached mode (`-d`)
- Maps port 8080 from the container to port 8080 on your host machine (`-p 8080:8080`)
- Uses the official plastichub/kbot image
## Container Configuration
### Environment Variables
The Docker container can be configured using environment variables:
```bash
docker run -d \
-p 8080:8080 \
-e OSR_CONFIG='{"openrouter":{"key":"your-key"}}' \
plastichub/kbot
```
### Volumes
To persist data or use custom configurations:
```bash
docker run -d \
-p 8080:8080 \
-v $(pwd):/workspace \
plastichub/kbot
```
### Docker Compose
Example docker-compose.yml:
```yaml
version: '3'
services:
kbot:
image: plastichub/kbot
ports:
- "8080:8080"
volumes:
- .:/workspace
```
Run with:
```bash
docker-compose up -d
```