Skip to content

Commit d0d9e66

Browse files
committed
docs(readme): promote auto_source feature & fix yaml parsing in examples
1 parent e94c28e commit d0d9e66

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ This web application scrapes websites to build and deliver RSS 2.0 feeds.
66

77
**Features:**
88

9+
- Provides stable URLs for feeds generated by automatic sourcing.
910
- [Create your custom feeds](#how-to-build-your-rss-feeds)!
1011
- Comes with plenty of [included configs](https://github.com/html2rss/html2rss-configs) out of the box.
1112
- Handles request caching.
@@ -48,7 +49,7 @@ services:
4849
RACK_ENV: production
4950
HEALTH_CHECK_USERNAME: health
5051
HEALTH_CHECK_PASSWORD: please-set-YOUR-OWN-veeeeeery-l0ng-aNd-h4rd-to-gue55-Passw0rd!
51-
# AUTO_SOURCE_ENABLED: true
52+
# AUTO_SOURCE_ENABLED: 'true'
5253
# AUTO_SOURCE_USERNAME: foobar
5354
# AUTO_SOURCE_PASSWORD: A-Unique-And-Long-Password-For-Your-Own-Instance
5455
## to allow just requests originating from the local host
@@ -83,7 +84,7 @@ To enable the `auto_source` feature, comment in the env variables in the `docker
8384
```yaml
8485
environment:
8586
## … snip ✁
86-
AUTO_SOURCE_ENABLED: true
87+
AUTO_SOURCE_ENABLED: "true"
8788
AUTO_SOURCE_USERNAME: foobar
8889
AUTO_SOURCE_PASSWORD: A-Unique-And-Long-Password-For-Your-Own-Instance
8990
## to allow just requests originating from the local host
@@ -93,7 +94,7 @@ environment:
9394
## … snap ✃
9495
```
9596

96-
Restart the container and open <http://127.0.0.1:3000/auto_source>.
97+
Restart the container and open <http://127.0.0.1:3000/auto_source/>.
9798
When asked, enter your username and password.
9899

99100
Then enter the URL of a website and click on the _Generate_ button.
@@ -152,8 +153,8 @@ If you're going to host a public instance, _please, please, please_:
152153
| `HEALTH_CHECK_PASSWORD` | default: auto-generated on start |
153154
| | |
154155
| `AUTO_SOURCE_ENABLED` | default: false |
155-
| `AUTO_SOURCE_USERNAME | no default |
156-
| `AUTO_SOURCE_PASSWORD | no default |
156+
| `AUTO_SOURCE_USERNAME` | no default. |
157+
| `AUTO_SOURCE_PASSWORD` | no default. |
157158
| `AUTO_SOURCE_ALLOWED_ORIGINS` | no default. |
158159
| | |
159160
| `PORT` | default: 3000 |

0 commit comments

Comments
 (0)