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

Change definition of scraper in documentation

Browse Source
This commit is contained in:
Mike Dilger 2024-03-05 10:31:08 +13:00
parent 5a7f9fee7a
commit 6d9868d745
3 changed files with 13 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
contrib/chorus.toml
View File

@ -114,14 +114,12 @@ user_hex_keys = []
verify_events = true
# This is a boolean indicating whether or not scraping is allowed.
# Scraping is any filter that does not match one of the following conditions:
# This is a boolean indicating whether or not scraping is allowed. Scraping is any filter
# where all of the following are true:
#
# A non-empty id list is set
# A non-empty authors list is set and a non-empty kinds list is set
# A non-empty authors list is set and at least one tag is set.
# A non-empty kinds list is set and at least one tag is set.
# Has a limit <= 10
# - `ids` is missing or empty
# - `authors` is missing or empty
# - There are no `#X` tag filters
#
# Filter that fail to match these conditions will be rejected if allow_scraping is false.
#

10
docs/BEHAVIOR.md
View File

@ -28,13 +28,11 @@ Chorus serves all events to AUTHed and authorized users.
Chorus serves all events which were authored by an authorized user.
Filters which are broad are considered scrapers and are not serviced. Filters must meet one of the following criteria:
Filters which are broad are considered scrapers and are not serviced. Scraping is any filter where all of the following are true:
- A non-empty `id` list is set
- A non-empty `authors` list is set and a non-empty `kinds` list is set
- A non-empty `authors` list is set and at least one tag is set.
- A non-empty `kinds` list is set and at least one tag is set.
- Has a limit <= 10.
- `ids` is missing or empty
- `authors` is missing or empty
- There are no `#X` tag filters
If you wish to change these rules, change the source code at `nostr.rs:screen_outgoing_event()`

10
docs/CONFIG.md
View File

@ -105,13 +105,11 @@ Default is true.
### allow_scraping
This is a boolean indicating whether or not scraping is allowed. Scraping is any filter that does not match one of the following conditions:
This is a boolean indicating whether or not scraping is allowed. Scraping is any filter where all of the following are true:
- A non-empty `id` list is set
- A non-empty `authors` list is set and a non-empty `kinds` list is set
- A non-empty `authors` list is set and at least one tag is set.
- A non-empty `kinds` list is set and at least one tag is set.
- Has a limit <= 10
- `ids` is missing or empty
- `authors` is missing or empty
- There are no `#X` tag filters
Filter that fail to match these conditions will be rejected if `allow_scraping` is false.