nik/chorus
1
0
Fork 0
mirror of https://github.com/mikedilger/chorus.git synced 2026-08-31 07:31:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve documentation around allow_scraping

Browse Source
This commit is contained in:
Mike Dilger 2025-01-21 11:42:38 +13:00
parent fb80811f9f
commit 2295f4b9fc
No known key found for this signature in database
GPG Key ID: 47581A78D4329BA4
2 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
contrib/chorus.toml
View File

@ -164,10 +164,10 @@ verify_events = true
# Filter that fail to match these conditions will be rejected if allow_scraping is false.
#
# If allow_scraping is true, be aware that filters that don't match any of these conditions
# have no indexes to speed up their query, so they scan through every single event on the relay.
# (and are not bound by since/until/limit) have no indexes to speed up their query, so they
# scan through every single event on the relay.
#
# The purpose of this setting is as a temporary setting that allows you to dump every single
# event on your relay, but the `dump` binary automatically sets it while it runs.
# See also `allow_scrape_if_limited_to` and `allow_scrape_if_max_seconds`.
#
# Default is false.
#
@ -176,7 +176,8 @@ allow_scraping = false
# This is a u32 count of events indicating a filter `limit` value under which a scrape is
# allowed, irrespective of the `allow_scraping` setting. Such scrapes are not expensive due
# to the limit.
# to the limit. The limit must be specified in the filter; it does not do the scrape and
# then count to see if it was under the limit.
#
# See `allow_scraping` to learn the definition of a scrape.
#

6
docs/CONFIG.md
View File

@ -146,15 +146,15 @@ This is a boolean indicating whether or not scraping is allowed. Scraping is any
Filter that fail to match these conditions will be rejected if `allow_scraping` is false.
If `allow_scraping` is true, be aware that filters that don't match any of these conditions have no indexes to speed up their query, so they scan through every single event on the relay.
If `allow_scraping` is true, be aware that filters that don't match any of these conditions (and are not bound by since/until/limit) have no indexes to speed up their query, so they scan through every single event on the relay.
The purpose of this setting is as a temporary setting that allows you to dump every single event on your relay.
See also `allow_scrape_if_limited_to` and # `allow_scrape_if_max_seconds`.
Default is false.
### allow_scrape_if_limited_to
This is a u32 count of events indicating a filter `limit` value under which a scrape is allowed, irrespective of the `allow_scraping` setting. Such scrapes are not expensive due to the limit.
This is a u32 count of events indicating a filter `limit` value under which a scrape is allowed, irrespective of the `allow_scraping` setting. Such scrapes are not expensive due to the limit. The limit must be specified in the filter; it does not do the scrape and then count to see if it was under the limit.
See `allow_scraping` to learn the definition of a scrape.