You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Ready to get RSS feeds from any website? Run `html2rss-web` locally with Docker, verify the interface, then start with included feeds before you move on to custom configs.
10
+
## Start Here
12
11
13
-
## What Success Looks Like
12
+
If you want the recommended path, go to [Run html2rss-web with Docker](/web-application/getting-started).
14
13
15
-
After this guide, you should have:
14
+
That guide is the canonical setup flow for:
16
15
17
-
-`html2rss-web`running at `http://localhost:3000`
18
-
-a list of working included feeds
19
-
-a clear next step for either auto-generation or custom configs
16
+
-running `html2rss-web`locally
17
+
-confirming your first successful feed
18
+
-deciding when to use included feeds, automatic generation, or custom configs
20
19
21
-
## Recommended Path
20
+
## Quick Shortcuts
22
21
23
-
This guide will help you set up your own copy of `html2rss-web` on your computer. Start here if you want the most reliable path and the newest integrated behavior.
24
-
25
-
### What You'll Need
26
-
27
-
-**Docker** - A tool that makes installation simple (like an app store for server software)
28
-
-**About 10 minutes** - The whole process is quick and automated
29
-
30
-
**Don't have Docker?**[Install it first](https://docs.docker.com/get-started/) - it's free and works on all major operating systems.
31
-
32
-
### Step 1: Create a Folder
33
-
34
-
Create a new folder on your computer to store html2rss-web files:
35
-
36
-
**Create a new folder** on your computer and name it "html2rss-web". You can do this through your file manager or terminal:
37
-
38
-
```bash
39
-
mkdir html2rss-web
40
-
cd html2rss-web
41
-
```
42
-
43
-
### Step 2: Create a Minimal Configuration File
44
-
45
-
Create a file called `docker-compose.yml` in your new folder. Start with the minimal local stack:
46
-
47
-
<MinimalDockerCompose />
48
-
49
-
Add update automation such as Watchtower later, after the first run works.
50
-
51
-
### Step 3: Download the Feed List
52
-
53
-
html2rss-web needs a list of feeds to work with. Download our pre-made list:
54
-
55
-
**Download the feeds.yml file:**
56
-
57
-
-**Using your browser:** Right-click [this link](https://raw.githubusercontent.com/html2rss/html2rss-web/master/config/feeds.yml) → Save As → Name it "feeds.yml" → Save in your html2rss-web folder
58
-
-**Using terminal:** Open Terminal in your html2rss-web folder and run:
Copy file name to clipboardExpand all lines: src/content/docs/web-application/index.mdx
+18-6Lines changed: 18 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,17 +6,29 @@ sidebar:
6
6
order: 1
7
7
---
8
8
9
-
This web application scrapes websites to build and deliver RSS 2.0 feeds. It is a powerful tool for creating custom RSS feeds.
9
+
`html2rss-web` is the recommended way to get started. Run it locally with Docker, use included feeds first, and move to automatic generation or custom configs only when you need more control.
10
10
11
11
## Get Started
12
12
13
-
Our **[Getting Started guide](/web-application/getting-started)** covers essential first steps, from understanding the application to installing your own instance.
13
+
Start with **[Getting Started](/web-application/getting-started)** to:
14
+
15
+
- run your own local instance
16
+
- confirm a first successful feed
17
+
- choose the right next step for your site
14
18
15
19
## Key Features
16
20
17
-
-**Stable URLs:** Provides stable URLs for automatically sourced feeds.
18
-
-**Custom Feeds:** Create custom feeds.
19
-
-**Feed Directory:** Includes many [feeds](https://github.com/html2rss/html2rss-configs) out of the box.
20
-
-**Caching:** Handles request caching and sets HTTP headers.
21
+
-**Stable URLs:** Provides stable URLs for feeds served from your own instance
22
+
-**Included Feeds:** Start with many working configs out of the box
23
+
-**Automatic Generation:** Try new sites quickly when the feature is enabled
24
+
-**Custom Feeds:** Create and refine your own configs when you need more control
25
+
-**Caching:** Handles request caching and sets HTTP headers
21
26
22
27
The functionality of scraping websites and building the RSS feeds is provided by the Ruby gem [`html2rss`](https://github.com/html2rss/html2rss).
28
+
29
+
## Recommended Flow
30
+
31
+
1.**[Getting Started](/web-application/getting-started)** - Run the app locally
32
+
2.**[Use the included configs](/web-application/how-to/use-included-configs/)** - Confirm a working feed first
0 commit comments