8003ec28f21d641e4284c9a2021a67899040d50f
- Author
- Ayman Bagabas <ayman.bagabas@gmail.com>
- Committer
- Ayman Bagabas <ayman.bagabas@gmail.com>
- Date
Message
readme: add running soft-serve as a container
Diff
1diff --git a/README.md b/README.md
2index c0ce51235a420fc9031d205ef4cf53f71e03893d..19382d378e0c69573207f5dbdaa5643329bdee94 100644
3--- a/README.md
4+++ b/README.md
5@@ -30,6 +30,35 @@ go install
6
7 Make sure `git` is installed, then run `soft`. That’s it.
8
9+## Docker
10+
11+Here are some example snippets to help you run `soft-serve` as a container.
12+
13+```sh
14+docker run -d \
15+ --name=soft-seve \
16+ -v /path/to/data:/soft-serve \
17+ -p 23231:23231 \
18+ --restart unless-stopped \
19+ ghcr.io/charmbracelet/soft-serve:latest
20+```
21+
22+or by using docker-compose
23+
24+```yaml
25+---
26+version: "3.1"
27+services:
28+ soft-serve:
29+ image: ghcr.io/charmbracelet/soft-serve:latest
30+ container_name: soft-serve
31+ volumes:
32+ - /path/to/data:/soft-serve
33+ ports:
34+ - 23231:23231
35+ restart: unless-stopped
36+```
37+
38 ## Configuration
39
40 The Soft Serve configuration is simple and straightforward: