Skip to content

Commit 04f9629

Browse files
committed
docs: rewrite web onboarding around included feeds
1 parent 731036c commit 04f9629

5 files changed

Lines changed: 56 additions & 63 deletions

File tree

src/components/docs/DockerComposeSnippet.astro

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,28 +14,24 @@ const snippets: Record<Props["variant"], string> = {
1414
image: ${webImage}
1515
restart: unless-stopped
1616
ports:
17-
- "127.0.0.1:3000:3000"
18-
volumes:
19-
- type: bind
20-
source: ./feeds.yml
21-
target: /app/config/feeds.yml
22-
read_only: true
17+
- "127.0.0.1:4000:4000"
2318
environment:
2419
RACK_ENV: production
25-
HEALTH_CHECK_USERNAME: health
26-
HEALTH_CHECK_PASSWORD: CHANGE_THIS_PASSWORD_BEFORE_USE
27-
BROWSERLESS_IO_WEBSOCKET_URL: ws://browserless:3001
28-
BROWSERLESS_IO_API_TOKEN: 6R0W53R135510
20+
PORT: 4000
21+
HTML2RSS_SECRET_KEY: your-generated-secret-key
22+
HEALTH_CHECK_TOKEN: your-health-check-token
23+
BROWSERLESS_IO_WEBSOCKET_URL: ws://browserless:4002
24+
BROWSERLESS_IO_API_TOKEN: your-browserless-token
2925
3026
browserless:
3127
image: "${browserlessImage}"
3228
restart: unless-stopped
3329
ports:
34-
- "127.0.0.1:3001:3001"
30+
- "127.0.0.1:4002:4002"
3531
environment:
36-
PORT: 3001
32+
PORT: 4002
3733
CONCURRENT: 10
38-
TOKEN: 6R0W53R135510`,
34+
TOKEN: your-browserless-token`,
3935
productionCaddy: `services:
4036
caddy:
4137
image: ${caddyImage}

src/content/docs/index.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
title: "Turn Any Website Into an RSS Feed"
3-
description: "Run html2rss-web with Docker, open the web interface, generate stable feed URLs, and move to custom configs only when you need more control."
3+
description: "Run html2rss-web with Docker, open a working included feed from your own instance, and move to feature enablement or custom configs only when you need more control."
44
---
55

6-
Run `html2rss-web` with Docker, open the web interface, and generate stable feed URLs from pages you want to follow.
6+
Run `html2rss-web` with Docker, open a working included feed from your own instance, and move to direct generation or custom configs only when you need more control.
77

88
## Start Here
99

@@ -13,13 +13,13 @@ That guide is the canonical onboarding flow for:
1313

1414
- starting a local instance
1515
- verifying the web interface
16-
- generating a first feed URL
16+
- opening a first included feed URL
1717
- deciding when to use automatic generation or custom configs
1818

1919
## How It Works
2020

2121
1. **Run your own local instance** with Docker
22-
2. **Open the web interface** and paste a page URL
22+
2. **Open a built-in feed URL** from your own instance
2323
3. **Copy the feed URL into your reader**
2424

2525
## What is html2rss?
@@ -36,7 +36,7 @@ Most people should start with the web application:
3636
### I want a working instance first
3737

3838
1. **[Run html2rss-web with Docker](/web-application/getting-started)**: recommended starting path
39-
2. **[Use automatic feed generation](/web-application/how-to/use-automatic-feed-generation/)**: create a feed directly from a page URL
39+
2. **[Use the included configs](/web-application/how-to/use-included-configs/)**: use real embedded feeds from your own instance
4040
3. **[Browse working feed examples](/feed-directory/)**: see what working outputs look like
4141

4242
### I need more control
@@ -62,8 +62,8 @@ Most people should start with the web application:
6262
## Practical Notes
6363

6464
- Start with Docker, not a public instance.
65-
- Use the web interface to verify the deployment first.
66-
- Use automatic generation for the first pass.
65+
- Use an included feed to verify the deployment first.
66+
- Enable automatic generation only when you want the direct page-URL workflow.
6767
- Move to custom configs when you need a stable, reviewable setup.
6868

6969
**Need help?** Continue to the [troubleshooting guide](/troubleshooting/troubleshooting) or join [GitHub Discussions](https://github.com/orgs/html2rss/discussions).
Lines changed: 20 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
---
22
title: "Getting Started"
3-
description: "Run html2rss-web locally with Docker, verify the interface, and generate your first feed URL."
3+
description: "Run html2rss-web locally with Docker, verify the interface, and open your first included feed."
44
sidebar:
55
order: 2
66
---
77

88
import AutoGenerationOptional from "../../../components/docs/AutoGenerationOptional.astro";
99
import MinimalDockerCompose from "../../../components/docs/MinimalDockerCompose.astro";
1010

11-
Run `html2rss-web` locally with Docker, open the web interface, and verify that you can generate a working feed URL.
11+
Run `html2rss-web` locally with Docker, open the web interface, and verify that your instance can serve a working included feed.
1212

1313
## What You Will Have When This Works
1414

1515
After this guide, you should have:
1616

17-
- `html2rss-web` running at `http://localhost:3000`
17+
- `html2rss-web` running at `http://localhost:4000`
1818
- the web interface loading correctly
19-
- a first feed URL you can copy into your reader
19+
- a first included feed URL you can copy into your reader
2020
- a clear path to either custom configs or more advanced setup
2121

2222
## Installation Guide
@@ -47,18 +47,7 @@ Create a file called `docker-compose.yml` in that folder and start with the mini
4747

4848
Add update automation later, after the first run works.
4949

50-
### Step 3: Download `feeds.yml`
51-
52-
Download the default `feeds.yml` file:
53-
54-
- **Browser:** Right-click [this link](https://raw.githubusercontent.com/html2rss/html2rss-web/master/config/feeds.yml) and save it as `feeds.yml`
55-
- **Terminal:**
56-
57-
```bash
58-
curl https://raw.githubusercontent.com/html2rss/html2rss-web/master/config/feeds.yml -o feeds.yml
59-
```
60-
61-
### Step 4: Start html2rss-web
50+
### Step 3: Start html2rss-web
6251

6352
Run:
6453

@@ -70,29 +59,32 @@ docker compose up -d
7059

7160
At this point, `html2rss-web` should be running.
7261

73-
1. Open `http://localhost:3000`
62+
1. Open `http://localhost:4000`
7463
2. Confirm the web interface loads
75-
3. Paste a page URL into `Create a feed`
76-
4. Generate a feed URL
77-
5. Copy that feed URL into your reader or open it directly
64+
3. Open one of the included feed URLs from your own instance:
65+
- `http://localhost:4000/microsoft.com/azure-products.rss`
66+
- `http://localhost:4000/phys.org/weekly.rss`
67+
- `http://localhost:4000/softwareleadweekly.com/issues.rss`
68+
4. Confirm the feed opens
69+
5. Copy that feed URL into your reader
7870

79-
If that works, the deployment, interface, and feed-generation path are working together.
71+
If that works, the deployment, static feed path, and reader subscription path are working together.
8072

8173
## What To Do First
8274

83-
Start with the web interface itself:
75+
Start with an included config from your own instance:
8476

85-
1. create one feed from a known page URL
86-
2. open or copy the generated feed URL
77+
1. open a known included feed URL
78+
2. copy that feed URL into your reader
8779
3. confirm your reader can subscribe successfully
8880

89-
That proves the core path before you invest in deeper customization.
81+
That proves the core path before you invest in custom configs or feature enablement.
9082

9183
<AutoGenerationOptional />
9284

9385
## Next Steps
9486

95-
1. **[Use automatic feed generation](/web-application/how-to/use-automatic-feed-generation/)**: understand the web UI creation path in more detail
96-
2. **[Create Custom Feeds](/creating-custom-feeds)**: write your own configs when you need reviewable extraction rules
97-
3. **[Browse working feed examples](/feed-directory/)**: compare outputs and existing configs
87+
1. **[Use the included configs](/web-application/how-to/use-included-configs/)**: understand how built-in feed paths work
88+
2. **[Use automatic feed generation](/web-application/how-to/use-automatic-feed-generation/)**: enable direct feed creation from page URLs when you want that workflow
89+
3. **[Create Custom Feeds](/creating-custom-feeds)**: write your own configs when you need reviewable extraction rules
9890
4. **[Need help?](/troubleshooting/troubleshooting)**: troubleshoot startup and extraction problems
Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
---
22
title: "Use the included configs"
3-
description: "html2rss-web comes with hundreds of ready-made feeds for popular websites! No configuration needed - just use the URLs."
3+
description: "Use the embedded html2rss-configs feed set from your own html2rss-web instance."
44
---
55

6-
html2rss-web comes with hundreds of ready-made feeds for popular websites! No configuration needed - just use the URLs.
6+
`html2rss-web` can serve the embedded `html2rss-configs` feed set directly from your own instance. This is the fastest path when you want a working feed without writing YAML first.
77

88
## How to Use Them
99

1010
1. **Find a feed** in the [Feed Directory](/feed-directory/)
11-
2. **Copy the URL** (it looks like `domainname.tld/whatever.rss`)
12-
3. **Add it to your feed reader** - paste the URL and you're done!
11+
2. **Set the Instance URL** to your own `html2rss-web` address
12+
3. **Open the local feed path** from your instance
13+
4. **Add it to your feed reader**
1314

1415
## What Success Looks Like
1516

@@ -23,10 +24,10 @@ If that works, keep using included configs for that site. It is the lowest-maint
2324

2425
## Example
2526

26-
If you see a config file named `example.com/news.yml`, you can access it at:
27-
`http://localhost:3000/example.com/news.rss`
27+
If you see a config file named `phys.org/weekly.yml`, you can access it at:
28+
`http://localhost:4000/phys.org/weekly.rss`
2829

29-
Just replace `localhost:3000` with your html2rss-web address.
30+
Just replace `localhost:4000` with your own `html2rss-web` address.
3031

3132
## When to Move On
3233

@@ -36,4 +37,7 @@ Use a custom config when:
3637
- the included feed misses fields you care about
3738
- you need a more specific page, section, or output format
3839

39-
Next step: [Create Custom Feeds](/creating-custom-feeds)
40+
Next steps:
41+
42+
- [Use automatic feed generation](/web-application/how-to/use-automatic-feed-generation/) when you want to create feeds directly from page URLs
43+
- [Create Custom Feeds](/creating-custom-feeds) when you need a reviewable config
Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
---
22
title: "Web Application"
3-
description: "html2rss-web is the self-hosted web interface for generating stable feed URLs from web pages."
3+
description: "html2rss-web is the self-hosted web interface and feed server for running included feeds first, then enabling direct generation only when needed."
44
sidebar:
55
label: "Overview"
66
order: 1
77
---
88

9-
`html2rss-web` is the recommended way to get started. Run it locally with Docker, open the interface, generate a feed URL, and move to custom configs only when you need more control.
9+
`html2rss-web` is the recommended way to get started. Run it locally with Docker, verify a working included feed from your own instance, and only then decide whether you need direct generation or custom configs.
1010

1111
## Get Started
1212

1313
Start with **[Getting Started](/web-application/getting-started)** to:
1414

1515
- run your own local instance
1616
- verify the web interface
17-
- generate a first feed URL
17+
- open a first included feed URL
1818
- choose the right next step for your site
1919

2020
## What The Web App Gives You
2121

22-
- **Stable feed URLs:** generated from your own deployment
23-
- **Web interface:** paste a page URL and create a feed
22+
- **Included feed catalog:** real embedded configs you can use immediately from your own deployment
23+
- **Web interface:** direct feed creation when you explicitly enable it
2424
- **Optional access control:** unlock custom generation with an access token when configured
2525
- **Config-based extension path:** move to custom feeds when you need reviewable rules
2626
- **Caching and HTTP handling:** shipped as part of the deployment
@@ -30,6 +30,7 @@ The scraping and feed-building engine is provided by the Ruby gem [`html2rss`](h
3030
## Recommended Flow
3131

3232
1. **[Getting Started](/web-application/getting-started)**: run the app locally
33-
2. **[Use automatic feed generation](/web-application/how-to/use-automatic-feed-generation/)**: create a feed from a page URL
33+
2. **[Use the included configs](/web-application/how-to/use-included-configs/)**: start with embedded feed paths from your own instance
3434
3. **[Browse working feed examples](/feed-directory/)**: compare against existing outputs
35-
4. **[Create Custom Feeds](/creating-custom-feeds)**: build a stable custom setup when needed
35+
4. **[Use automatic feed generation](/web-application/how-to/use-automatic-feed-generation/)**: enable direct page-URL conversion when you want that workflow
36+
5. **[Create Custom Feeds](/creating-custom-feeds)**: build a stable custom setup when needed

0 commit comments

Comments
 (0)