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
Copy file name to clipboardExpand all lines: README.md
+8-232Lines changed: 8 additions & 232 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,245 +7,21 @@ This web application scrapes websites to build and deliver RSS 2.0 feeds.
7
7
**Features:**
8
8
9
9
- Provides stable URLs for feeds generated by automatic sourcing.
10
-
-[Create your custom feeds](#how-to-build-your-rss-feeds)!
11
-
- Comes with plenty of [included configs](https://github.com/html2rss/html2rss-configs) out of the box.
10
+
-[Create your custom feeds](https://html2rss.github.io/web-application/tutorials/building-feeds)!
11
+
- Comes with plenty of [included configs](https://html2rss.github.io/web-application/how-to/use-included-configs).
12
12
- Handles request caching.
13
13
- Sets caching-related HTTP headers.
14
14
15
15
The functionality of scraping websites and building the RSS feeds is provided by the Ruby gem [`html2rss`](https://github.com/html2rss/html2rss).
16
16
17
-
## Get started
17
+
## Documentation
18
18
19
-
This application should be used with Docker. It is designed to require as little maintenance as possible. See [Versioning and Releases](#versioning-and-releases) and [consider automatic updates](#docker-automatically-keep-the-html2rss-web-image-up-to-date).
19
+
For full documentation, please see the [html2rss-web documentation](https://html2rss.github.io/web-application/).
20
20
21
-
### With Docker
21
+
##Contributing
22
22
23
-
```sh
24
-
docker run -p 3000:3000 gilcreator/html2rss-web
25
-
```
23
+
Contributions are welcome! Please see the [contributing guide](https://html2rss.github.io/get-involved/contributing) for more information.
26
24
27
-
Then open <http://127.0.0.1:3000/> in your browser and click the example feed link.
25
+
## Sponsoring
28
26
29
-
This is the quickest way to get started. However, it's also the option with the least flexibility: it doesn't allow you to use custom feed configs and doesn't update automatically.
30
-
31
-
If you want more flexibility and automatic updates sound good to you, read on to get started _with docker compose_…
32
-
33
-
### With `docker compose`
34
-
35
-
Create a `docker-compose.yml` file and paste the following into it:
If you have not created your `feeds.yml` yet, download [this `feeds.yml` as a blueprint](https://raw.githubusercontent.com/html2rss/html2rss-web/master/config/feeds.yml) into the directory containing the `docker-compose.yml`.
82
-
83
-
## Docker: Automatically keep the html2rss-web image up-to-date
84
-
85
-
The [watchtower](https://containrrr.dev/watchtower/) service automatically pulls running Docker images and checks for updates. If an update is available, it will automatically start the updated image with the same configuration as the running one. Please read its manual.
86
-
87
-
The `docker-compose.yml` above contains a service description for watchtower.
88
-
89
-
## How to use automatic feed generation
90
-
91
-
> [!NOTE]
92
-
> This feature is disabled by default.
93
-
94
-
To enable the `auto_source` feature, comment in the env variables in the `docker-compose.yml` file from above and change the values accordingly:
Restart the container and open <http://127.0.0.1:3000/auto_source/>.
110
-
When asked, enter your username and password.
111
-
112
-
Then enter the URL of a website and click on the _Generate_ button.
113
-
114
-
## How to use the included configs
115
-
116
-
html2rss-web comes with many feed configs out of the box. [See the file list of all configs.](https://github.com/html2rss/html2rss-configs/tree/master/lib/html2rss/configs)
117
-
118
-
To use a config from there, build the URL like this:
To build your own RSS feed, you need to create a _feed config_.\
130
-
That _feed config_ goes into the file `feeds.yml`.\
131
-
Check out the [`example` feed config](https://github.com/html2rss/html2rss-web/blob/master/config/feeds.yml#L9).
132
-
133
-
Please refer to [html2rss' README for a description of _the feed config and its options_](https://github.com/html2rss/html2rss#the-feed-config-and-its-options). html2rss-web is just a small web application that builds on html2rss.
134
-
135
-
## Versioning and releases
136
-
137
-
This web application is distributed in a [rolling release](https://en.wikipedia.org/wiki/Rolling_release) fashion from the `master` branch.
138
-
139
-
For the latest commit passing GitHub CI/CD on the master branch, an updated Docker image will be pushed to [Docker Hub: `gilcreator/html2rss-web`](https://hub.docker.com/r/gilcreator/html2rss-web).
140
-
The [SBOM](https://en.wikipedia.org/wiki/Software_supply_chain) is embedded in the Docker image.
141
-
142
-
GitHub's @dependabot is enabled for dependency updates and they are automatically merged to the `master` branch when the CI gives the green light.
143
-
144
-
If you use Docker, you should update to the latest image automatically by [setting up _watchtower_ as described](#get-started).
145
-
146
-
## Use in production
147
-
148
-
This app is published on Docker Hub and therefore easy to use with Docker.\
149
-
The above `docker-compose.yml` is a good starting point.
150
-
151
-
If you're going to host a public instance, _please, please, please_:
152
-
153
-
- Put the application behind a reverse proxy.
154
-
- Allow outside connections only via HTTPS.
155
-
- Have an auto-update strategy (e.g., watchtower).
156
-
- Monitor your `/health_check.txt` endpoint.
157
-
- [Let the world know and add your instance to the wiki](https://github.com/html2rss/html2rss-web/wiki/Instances) -- thank you!
| `HEALTH_CHECK_USERNAME` | default: auto-generated on start |
166
-
| `HEALTH_CHECK_PASSWORD` | default: auto-generated on start |
167
-
| | |
168
-
| `AUTO_SOURCE_ENABLED` | default: false |
169
-
| `AUTO_SOURCE_USERNAME` | no default. |
170
-
| `AUTO_SOURCE_PASSWORD` | no default. |
171
-
| `AUTO_SOURCE_ALLOWED_ORIGINS` | no default. |
172
-
| | |
173
-
| `PORT` | default: 3000 |
174
-
| `RACK_ENV` | default: 'development'|
175
-
| `RACK_TIMEOUT_SERVICE_TIMEOUT` | default: 15 |
176
-
| `WEB_CONCURRENCY` | default: 2 |
177
-
| `WEB_MAX_THREADS` | default: 5 |
178
-
| | |
179
-
| `SENTRY_DSN` | no default. |
180
-
181
-
### Runtime monitoring via `GET /health_check.txt`
182
-
183
-
It is recommended to set up monitoring of the `/health_check.txt` endpoint. With that, you can find out when one of _your own_ configs breaks. The endpoint uses HTTP Basic authentication.
184
-
185
-
First, set the username and password via these environment variables: `HEALTH_CHECK_USERNAME`and `HEALTH_CHECK_PASSWORD`. If these are not set, html2rss-web will generate a new random username and password on _each_ start.
186
-
187
-
An authenticated `GET /health_check.txt` request will respond with:
188
-
189
-
- If the feeds are generatable: `success`.
190
-
- Otherwise: the names of the broken configs.
191
-
192
-
To get notified when one of your configs breaks, set up monitoring of this endpoint.
193
-
194
-
[UptimeRobot's free plan](https://uptimerobot.com/) is sufficient for basic monitoring (every 5 minutes).\
195
-
Create a monitor of type _Keyword_ with this information and make it aware of your username and password:
196
-
197
-
198
-
199
-
### Application Performance Monitoring using Sentry
200
-
201
-
When you specify `SENTRY_DSN` in your environment variables, the application will be setup to use Sentry.
202
-
203
-
## Setup for development
204
-
205
-
Check out the git repository and…
206
-
207
-
### Using Docker
208
-
209
-
This approach allows you to experiment without installing Ruby on your machine.
210
-
All you need to do is install and run Docker.
211
-
212
-
```sh
213
-
# Build image from Dockerfile and name/tag it as html2rss-web:
0 commit comments