From fd2f9ecfcd363df4a59b398d31f81bebc420ab4f Mon Sep 17 00:00:00 2001
From: Christian Rocha
Date: Mon, 6 Dec 2021 10:35:06 -0500
Subject: [PATCH] Break out Docker info in README
---
DOCKER.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
README.md | 33 ++++-----------------------------
2 files changed, 50 insertions(+), 29 deletions(-)
create mode 100644 DOCKER.md
diff --git a/DOCKER.md b/DOCKER.md
new file mode 100644
index 000000000..1397865a3
--- /dev/null
+++ b/DOCKER.md
@@ -0,0 +1,46 @@
+# Running Soft-Serve with Docker
+
+The official Soft Serve Docker images are available at [charmcli/soft-serve][docker].
+
+```sh
+docker pull charmcli/soft-serve:latest
+```
+
+Here’s how you might run `soft-serve` as a container. Keep in mind that
+repositories are stored in the `/soft-serve` directory, so you’ll likely want
+to mount that directory as a volume in order keep your repositories backed up.
+
+```sh
+docker run -d \
+ --name=soft-seve \
+ --volume /path/to/data:/soft-serve \
+ --publish 23231:23231 \
+ --restart unless-stopped \
+ charmcli/soft-serve:latest
+```
+
+Or by using docker-compose:
+
+```yaml
+---
+version: "3.1"
+services:
+ soft-serve:
+ image: charmcli/soft-serve:latest
+ container_name: soft-serve
+ volumes:
+ - /path/to/data:/soft-serve
+ ports:
+ - 23231:23231
+ restart: unless-stopped
+```
+
+[docker]: https://hub.docker.com/r/charmcli/soft-serve
+
+***
+
+Part of [Charm](https://charm.sh).
+
+
+
+Charm热爱开源 • Charm loves open source
diff --git a/README.md b/README.md
index 0651c2172..8511b77fa 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@ Soft Serve
-A tasty Git server that runs its own SSH service. 🍦
+A tasty, self-hosted Git server for the command line. 🍦
@@ -41,34 +41,7 @@ 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 \
- charmcli/soft-serve:latest
-```
-
-or by using docker-compose:
-
-```yaml
----
-version: "3.1"
-services:
- soft-serve:
- image: charmcli/soft-serve:latest
- container_name: soft-serve
- volumes:
- - /path/to/data:/soft-serve
- ports:
- - 23231:23231
- restart: unless-stopped
-```
+A [Docker image](https://github.com/charmbracelet/soft-serve/blob/main/DOCKER.md) is also available.
## Configuration
@@ -179,6 +152,8 @@ environment-level settings:
***
+Part of [Charm](https://charm.sh).
+
Charm热爱开源 • Charm loves open source