From: Stefan Gasser Date: Sat, 17 Jan 2026 14:17:20 +0000 (+0100) Subject: Simplify Quick Start docker command (#44) X-Git-Url: http://git.99rst.org/?a=commitdiff_plain;h=c6e95f7f5e2d3db97e299965ca7d454f0635c032;p=sgasser-llm-shield.git Simplify Quick Start docker command (#44) --- diff --git a/README.md b/README.md index c7db376..c39fc8e 100644 --- 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)** diff --git a/docs/installation.mdx b/docs/installation.mdx index 328e6c0..fd9ab5a 100644 --- a/docs/installation.mdx +++ b/docs/installation.mdx @@ -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. diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index 1d98b8b..3603f76 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -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. For custom configuration, European languages, or persistent logs, see [Installation](/installation).