Skip to content

Commit c4f227e

Browse files
committed
docs: env + strategy adjustment
1 parent 64d1129 commit c4f227e

3 files changed

Lines changed: 13 additions & 2 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ pnpm-debug.log*
1616
# environment variables
1717
.env
1818
.env.production
19+
!examples/deployment/.env
1920

2021
# macOS-specific files
2122
.DS_Store

src/content/docs/troubleshooting/troubleshooting.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ If parts of your items (e.g., title, link) are missing, check the following:
9595

9696
- **Selector:** Ensure the selector for the missing part is correct and relative to the `items.selector`.
9797
- **Extractor:** Verify that you are using the correct `extractor` (e.g., `text`, `href`, `attribute`).
98-
- **Dynamic Content:** `html2rss` does not execute JavaScript. If the content is loaded dynamically, `html2rss` may not be able to see it.
98+
- **Dynamic Content:** `faraday` does not render JavaScript. If content loads dynamically, run with `--strategy browserless` (with the Browserless service available) so the page can be rendered before extraction.
9999

100100
### Date/Time Parsing Errors
101101

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

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,17 @@ This minimal stack intentionally proves the included-feed path first. Add automa
4949

5050
### Step 3: Start html2rss-web
5151

52-
Run:
52+
Create a `.env` file in the same folder (minimum required values for this stack):
53+
54+
```bash
55+
cat > .env <<EOF
56+
HTML2RSS_SECRET_KEY=$(openssl rand -hex 32)
57+
HEALTH_CHECK_TOKEN=$(openssl rand -hex 24)
58+
BROWSERLESS_IO_API_TOKEN=trial-browserless-token
59+
EOF
60+
```
61+
62+
Then run:
5363

5464
```bash
5565
docker compose up -d

0 commit comments

Comments
 (0)