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
@@ -26,24 +28,32 @@ html2rss-web converts arbitrary websites into RSS 2.0 feeds with a slim Ruby bac
26
28
27
29
For detailed architecture and internal rules, see [docs/README.md](docs/README.md).
28
30
29
-
## Trial Run (Docker Pull And Run)
31
+
## Trial Run (Docker Compose)
30
32
31
-
The published image already includes a sample `config/feeds.yml`, so you can try the app without creating or mounting one first.
33
+
The published image already includes a sample `config/feeds.yml`, so you can try the app without creating or mounting one first. Use Docker Compose for the trial run because the current production boot path requires build metadata and the bundled Browserless wiring from the checked-in compose file.
34
+
35
+
Pull the image explicitly if you want to confirm the published Docker Hub tag first:
-`http://localhost:4000/microsoft.com/azure-products.rss` for a built-in Azure updates feed
54
+
-`http://localhost:4000/openapi.yaml` for the generated OpenAPI document
45
55
46
-
This trial run is intentionally minimal. Use Docker Compose for Browserless, auto-updates, or local feed overrides.
56
+
This trial run is intentionally minimal. Stop it with `docker compose down`. Keep the checked-in `docker-compose.yml` as the baseline for real deployments, especially if you want Browserless, auto-updates, or local feed overrides.
47
57
48
58
## Deploy (Docker Compose)
49
59
@@ -68,6 +78,27 @@ export SENTRY_ENABLE_LOGS=true
68
78
69
79
UI + API run on `http://localhost:4000`. The app exits if the secret key is missing.
70
80
81
+
Production defaults matter:
82
+
83
+
-`AUTO_SOURCE_ENABLED` is `false` in production unless you set it to `true`.
84
+
- The create-feed API at `/api/v1/feeds` requires a bearer token.
85
+
-`faraday` is the default strategy; the UI retries once with `browserless` when `faraday` cannot finish the page.
86
+
87
+
If you enable automatic feed generation, make sure you also configure token distribution and Browserless for JavaScript-heavy pages.
88
+
89
+
## Integration Discovery
90
+
91
+
These are the stable entry points for tooling and agents:
92
+
93
+
- OpenAPI: [`public/openapi.yaml`](public/openapi.yaml) in the repo, or `/openapi.yaml` from a running instance
0 commit comments