Skip to content

Commit

Permalink
readme: add running soft-serve as a container
Browse files Browse the repository at this point in the history
  • Loading branch information
aymanbagabas committed Nov 18, 2021
1 parent b1c983c commit 8003ec2
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,35 @@ go install

Make sure `git` is installed, then run `soft`. That’s it.

## Docker

Here are some example snippets to help you run `soft-serve` as a container.

```sh
docker run -d \
--name=soft-seve \
-v /path/to/data:/soft-serve \
-p 23231:23231 \
--restart unless-stopped \
ghcr.io/charmbracelet/soft-serve:latest
```

or by using docker-compose

```yaml
---
version: "3.1"
services:
soft-serve:
image: ghcr.io/charmbracelet/soft-serve:latest
container_name: soft-serve
volumes:
- /path/to/data:/soft-serve
ports:
- 23231:23231
restart: unless-stopped
```
## Configuration
The Soft Serve configuration is simple and straightforward:
Expand Down

0 comments on commit 8003ec2

Please sign in to comment.