Skip to content

docs: centralize docker compose quick start #967

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 8, 2025
Merged

docs: centralize docker compose quick start #967

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/content/docs/web-application/getting-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ Ready to run your own html2rss-web instance? This guide walks you through every

---

## Installation Guide
## Docker Compose Quick Start {#docker-compose-quick-start}

This guide will help you set up your own copy of html2rss-web on your computer. Don't worry - we'll walk you through every step!
This is the canonical Docker Compose walkthrough for html2rss-web. Follow the steps below to set up your own copy on a local machine or server — we'll walk you through every detail!

### What You'll Need

Expand Down
29 changes: 6 additions & 23 deletions src/content/docs/web-application/how-to/deployment.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,33 +3,16 @@ title: "Deployment & Production"
description: "Deploy html2rss-web to production with Docker. Learn best practices for hosting public instances with security, monitoring, and reliability."
---

import { Steps } from '@astrojs/starlight/components';

html2rss-web is published on Docker Hub, making it easy to deploy with Docker. The [`docker-compose.yml`](https://github.com/html2rss/html2rss-web/blob/master/docker-compose.yml) from our [Installation Guide](/web-application/getting-started) provides a solid foundation for both development and production use.
html2rss-web is published on Docker Hub, making it easy to deploy with Docker. The [`docker-compose.yml`](https://github.com/html2rss/html2rss-web/blob/master/docker-compose.yml) from our [Docker Compose Quick Start](/web-application/getting-started/#docker-compose-quick-start) provides a solid foundation for both development and production use.

## Quick Start

<Steps>

1. **Create a directory** for your instance:
```bash
mkdir html2rss-web && cd html2rss-web
```

2. **Download the configuration** files:
```bash
curl -O https://raw.githubusercontent.com/html2rss/html2rss-web/master/docker-compose.yml
curl -O https://raw.githubusercontent.com/html2rss/html2rss-web/master/config/feeds.yml
```

3. **Start the instance**:
```bash
docker compose up -d
```

4. **Verify it's running** by opening [http://localhost:3000](http://localhost:3000) in your browser.
For the full, step-by-step walkthrough, follow the [Docker Compose Quick Start](/web-application/getting-started/#docker-compose-quick-start). In brief, you'll:

</Steps>
- Create a project directory for html2rss-web
- Download or create the provided `docker-compose.yml` and `feeds.yml`
- Start the stack with `docker compose up -d`
- Confirm the UI loads at [http://localhost:3000](http://localhost:3000)

> 📖 Need Docker? Follow the [Docker installation guide](https://docs.docker.com/get-docker/) and [Docker Compose install](https://docs.docker.com/compose/install/).

Expand Down