From e1b8686636eeecabb96d4ff4a8564d42afd623b1 Mon Sep 17 00:00:00 2001 From: Gil Desmarais Date: Sat, 21 Mar 2026 13:33:06 +0100 Subject: [PATCH] docs: simplify self-hosted web onboarding --- examples/deployment/docker-compose.yml | 39 +++++++ .../docs/AutoGenerationOptional.astro | 6 +- .../docs/DockerComposeSnippet.astro | 96 ++++++++++++++++ .../docs/MinimalDockerCompose.astro | 32 +----- src/content/docs/getting-started.mdx | 16 +-- src/content/docs/index.mdx | 108 ++++++------------ .../docs/web-application/getting-started.mdx | 75 ++++++------ .../web-application/how-to/deployment.mdx | 74 ++---------- .../how-to/use-automatic-feed-generation.mdx | 36 +++--- .../how-to/use-included-configs.mdx | 20 ++-- src/content/docs/web-application/index.mdx | 30 ++--- .../reference/versioning-and-releases.mdx | 4 +- src/data/docker.ts | 6 + 13 files changed, 287 insertions(+), 255 deletions(-) create mode 100644 examples/deployment/docker-compose.yml create mode 100644 src/components/docs/DockerComposeSnippet.astro create mode 100644 src/data/docker.ts diff --git a/examples/deployment/docker-compose.yml b/examples/deployment/docker-compose.yml new file mode 100644 index 00000000..5b98fa66 --- /dev/null +++ b/examples/deployment/docker-compose.yml @@ -0,0 +1,39 @@ +services: + html2rss: + image: html2rss/web:latest + env_file: .env + + caddy: + image: caddy:2-alpine + depends_on: + - html2rss + command: + - caddy + - reverse-proxy + - --from + - ${CADDY_HOST} + - --to + - html2rss:3000 + ports: + - "80:80" + - "443:443" + volumes: + - caddy_data:/data + + watchtower: + image: containrrr/watchtower + depends_on: + - html2rss + - caddy + command: + - --cleanup + - --interval + - "300" + - html2rss + - caddy + volumes: + - /var/run/docker.sock:/var/run/docker.sock:ro + restart: unless-stopped + +volumes: + caddy_data: diff --git a/src/components/docs/AutoGenerationOptional.astro b/src/components/docs/AutoGenerationOptional.astro index 35039fc9..982682bb 100644 --- a/src/components/docs/AutoGenerationOptional.astro +++ b/src/components/docs/AutoGenerationOptional.astro @@ -2,7 +2,7 @@ import { Aside } from "@astrojs/starlight/components"; --- -