fd2f9ecfcd363df4a59b398d31f81bebc420ab4f

Author
Christian Rocha <christian@rocha.is>
Committer
Christian Rocha <christian@rocha.is>
Date

Message

Break out Docker info in README

Diff

  1diff --git a/DOCKER.md b/DOCKER.md
  2new file mode 100644
  3index 0000000000000000000000000000000000000000..1397865a34a07b51e1b34c68ad8f5e1bfedad3e8
  4--- /dev/null
  5+++ b/DOCKER.md
  6@@ -0,0 +1,46 @@
  7+# Running Soft-Serve with Docker
  8+
  9+The official Soft Serve Docker images are available at [charmcli/soft-serve][docker].
 10+
 11+```sh
 12+docker pull charmcli/soft-serve:latest
 13+```
 14+
 15+Here’s how you might run `soft-serve` as a container.  Keep in mind that
 16+repositories are stored in the `/soft-serve` directory, so you’ll likely want
 17+to mount that directory as a volume in order keep your repositories backed up.
 18+
 19+```sh
 20+docker run -d \
 21+  --name=soft-seve \
 22+  --volume /path/to/data:/soft-serve \
 23+  --publish 23231:23231 \
 24+  --restart unless-stopped \
 25+  charmcli/soft-serve:latest
 26+```
 27+
 28+Or by using docker-compose:
 29+
 30+```yaml
 31+---
 32+version: "3.1"
 33+services:
 34+  soft-serve:
 35+    image: charmcli/soft-serve:latest
 36+    container_name: soft-serve
 37+    volumes:
 38+      - /path/to/data:/soft-serve
 39+    ports:
 40+      - 23231:23231
 41+    restart: unless-stopped
 42+```
 43+
 44+[docker]: https://hub.docker.com/r/charmcli/soft-serve
 45+
 46+***
 47+
 48+Part of [Charm](https://charm.sh).
 49+
 50+<a href="https://charm.sh/"><img alt="The Charm logo" src="https://stuff.charm.sh/charm-badge-unrounded.jpg" width="400"></a>
 51+
 52+Charm热爱开源 • Charm loves open source
 53diff --git a/README.md b/README.md
 54index 0651c21723053ab0e11b5aa6ee401907e7492f63..8511b77fa421b3a5957ee76c00e63846a69a667f 100644
 55--- a/README.md
 56+++ b/README.md
 57@@ -10,7 +10,7 @@ Soft Serve
 58     <a href="https://github.com/charmbracelet/soft-serve/actions"><img src="https://github.com/charmbracelet/soft-serve/workflows/build/badge.svg" alt="Build Status"></a>
 59 </p>
 60 
 61-A tasty Git server that runs its own SSH service. 🍦
 62+A tasty, self-hosted Git server for the command line. 🍦
 63 
 64 <img src="https://stuff.charm.sh/soft-serve/soft-serve-cli-demo.gif" width="700" alt="Soft Serve screencast">
 65 
 66@@ -41,34 +41,7 @@ go install
 67 
 68 Make sure `git` is installed, then run `soft`. That’s it.
 69 
 70-## Docker
 71-
 72-Here are some example snippets to help you run `soft-serve` as a container.
 73-
 74-```sh
 75-docker run -d \
 76-  --name=soft-seve \
 77-  -v /path/to/data:/soft-serve \
 78-  -p 23231:23231 \
 79-  --restart unless-stopped \
 80-  charmcli/soft-serve:latest
 81-```
 82-
 83-or by using docker-compose:
 84-
 85-```yaml
 86----
 87-version: "3.1"
 88-services:
 89-  soft-serve:
 90-    image: charmcli/soft-serve:latest
 91-    container_name: soft-serve
 92-    volumes:
 93-      - /path/to/data:/soft-serve
 94-    ports:
 95-      - 23231:23231
 96-    restart: unless-stopped
 97-```
 98+A [Docker image](https://github.com/charmbracelet/soft-serve/blob/main/DOCKER.md) is also available.
 99 
100 ## Configuration
101 
102@@ -179,6 +152,8 @@ environment-level settings:
103 
104 ***
105 
106+Part of [Charm](https://charm.sh).
107+
108 <a href="https://charm.sh/"><img alt="The Charm logo" src="https://stuff.charm.sh/charm-badge-unrounded.jpg" width="400"></a>
109 
110 Charm热爱开源 • Charm loves open source