Skip to content

Commit 9942762

Browse files
authored
docs: centralize docker compose quick start (#967)
1 parent 67fe6f4 commit 9942762

File tree

2 files changed

+8
-25
lines changed

2 files changed

+8
-25
lines changed

src/content/docs/web-application/getting-started.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ Ready to run your own html2rss-web instance? This guide walks you through every
3434

3535
---
3636

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

39-
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!
39+
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!
4040

4141
### What You'll Need
4242

src/content/docs/web-application/how-to/deployment.mdx

Lines changed: 6 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,33 +3,16 @@ title: "Deployment & Production"
33
description: "Deploy html2rss-web to production with Docker. Learn best practices for hosting public instances with security, monitoring, and reliability."
44
---
55

6-
import { Steps } from '@astrojs/starlight/components';
7-
8-
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.
6+
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.
97

108
## Quick Start
119

12-
<Steps>
13-
14-
1. **Create a directory** for your instance:
15-
```bash
16-
mkdir html2rss-web && cd html2rss-web
17-
```
18-
19-
2. **Download the configuration** files:
20-
```bash
21-
curl -O https://raw.githubusercontent.com/html2rss/html2rss-web/master/docker-compose.yml
22-
curl -O https://raw.githubusercontent.com/html2rss/html2rss-web/master/config/feeds.yml
23-
```
24-
25-
3. **Start the instance**:
26-
```bash
27-
docker compose up -d
28-
```
29-
30-
4. **Verify it's running** by opening [http://localhost:3000](http://localhost:3000) in your browser.
10+
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:
3111

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

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

0 commit comments

Comments
 (0)