From 8003ec28f21d641e4284c9a2021a67899040d50f Mon Sep 17 00:00:00 2001 From: Ayman Bagabas Date: Thu, 18 Nov 2021 14:15:55 -0500 Subject: [PATCH] readme: add running soft-serve as a container --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.md b/README.md index c0ce51235..19382d378 100644 --- a/README.md +++ b/README.md @@ -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: