Simplify Quick Start docker command (#44)
authorStefan Gasser <redacted>
Sat, 17 Jan 2026 14:17:20 +0000 (15:17 +0100)
committerGitHub <redacted>
Sat, 17 Jan 2026 14:17:20 +0000 (15:17 +0100)
README.md
docs/installation.mdx
docs/quickstart.mdx

index c7db376aea70014663c673f9a33d403517ec4a7e..c39fc8e26c058971f0dcd0114bffdc78729b323b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -75,19 +75,19 @@ PasteGuard sits between your app and your provider. It's OpenAI-compatible — j
 ## Quick Start
 
 ```bash
-docker run -d --name pasteguard -p 3000:3000 ghcr.io/sgasser/pasteguard:en
+docker run --rm -p 3000:3000 ghcr.io/sgasser/pasteguard:en
 ```
 
 Point your app to `http://localhost:3000/openai/v1` instead of `https://api.openai.com/v1`.
 
 Dashboard: [http://localhost:3000/dashboard](http://localhost:3000/dashboard)
 
-### Multiple Languages
+### European Languages
 
-For European languages (German, Spanish, French, Italian, Dutch, Polish, Portuguese, Romanian):
+For German, Spanish, French, Italian, Dutch, Polish, Portuguese, and Romanian:
 
 ```bash
-docker run -d --name pasteguard -p 3000:3000 ghcr.io/sgasser/pasteguard:eu
+docker run --rm -p 3000:3000 ghcr.io/sgasser/pasteguard:eu
 ```
 
 For custom config, persistent logs, or other languages: **[Read the docs →](https://pasteguard.com/docs/installation)**
index 328e6c02a7056a9264fa3dc06bb418cc65f0ea7f..fd9ab5ad9aed5e48630dc31b5282b7825b339a2b 100644 (file)
@@ -22,28 +22,8 @@ ghcr.io/sgasser/pasteguard
 
 ## Quick Start
 
-**Zero-config (works out of the box):**
-
-```bash
-docker run -d --name pasteguard -p 3000:3000 ghcr.io/sgasser/pasteguard:en
-```
-
-**With custom config and persistent logs:**
-
-```bash
-curl -O https://raw.githubusercontent.com/sgasser/pasteguard/main/config.example.yaml
-mv config.example.yaml config.yaml
-mkdir -p data
-docker run -d --name pasteguard -p 3000:3000 \
-  -v ./config.yaml:/app/config.yaml:ro \
-  -v ./data:/app/data \
-  ghcr.io/sgasser/pasteguard:en
-```
-
-**Verify:**
-
 ```bash
-curl http://localhost:3000/health
+docker run --rm -p 3000:3000 ghcr.io/sgasser/pasteguard:en
 ```
 
 Dashboard: [http://localhost:3000/dashboard](http://localhost:3000/dashboard)
@@ -53,7 +33,7 @@ Dashboard: [http://localhost:3000/dashboard](http://localhost:3000/dashboard)
 For German, Spanish, French, Italian, Dutch, Polish, Portuguese, and Romanian:
 
 ```bash
-docker run -d --name pasteguard -p 3000:3000 ghcr.io/sgasser/pasteguard:eu
+docker run --rm -p 3000:3000 ghcr.io/sgasser/pasteguard:eu
 ```
 
 Languages are auto-configured per image — no config changes needed. The EU image automatically enables all 9 European languages.
index 1d98b8bded0d82bcb51c74e148eee915c2dd5e8a..3603f76175fb8af79233de57e3014f81dbc05e63 100644 (file)
@@ -8,12 +8,10 @@ description: Get PasteGuard running in 2 minutes
 ## 1. Start PasteGuard
 
 ```bash
-docker run -d --name pasteguard -p 3000:3000 ghcr.io/sgasser/pasteguard:en
+docker run --rm -p 3000:3000 ghcr.io/sgasser/pasteguard:en
 ```
 
-That's it! PasteGuard runs on `http://localhost:3000` with sensible defaults.
-
-Dashboard: [http://localhost:3000/dashboard](http://localhost:3000/dashboard)
+PasteGuard runs on `http://localhost:3000`. Open `http://localhost:3000/dashboard` to see the dashboard.
 
 <Note>
 For custom configuration, European languages, or persistent logs, see [Installation](/installation).
git clone https://git.99rst.org/PROJECT