projectmoon
/
fediblockhole-misskey
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added documentation on allowlists.

This commit is contained in:
Justin Warren 2023-01-14 11:09:38 +11:00
parent 17e0bdab0b
commit 26f5464826
No known key found for this signature in database
1 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -159,11 +159,12 @@ Or you can use the default location of `/etc/default/fediblockhole.conf.toml`.
As the filename suggests, FediBlockHole uses TOML syntax. As the filename suggests, FediBlockHole uses TOML syntax.
There are 3 key sections: There are 4 key sections:
1. `blocklist_urls_sources`: A list of URLs to read blocklists from 1. `blocklist_urls_sources`: A list of URLs to read blocklists from
1. `blocklist_instance_sources`: A list of Mastodon instances to read blocklists from via API 1. `blocklist_instance_sources`: A list of Mastodon instances to read blocklists from via API
1. `blocklist_instance_destinations`: A list of Mastodon instances to write blocklists to via API 1. `blocklist_instance_destinations`: A list of Mastodon instances to write blocklists to via API
1. `allowlist_url_sources`: A list of URLs to read allowlists from
More detail on configuring the tool is provided below. More detail on configuring the tool is provided below.
@ -286,6 +287,25 @@ mergeplan.
Once the follow count drops to 0 on your instance, the tool will automatically Once the follow count drops to 0 on your instance, the tool will automatically
use the highest severity it finds again (if you're using the `max` mergeplan). use the highest severity it finds again (if you're using the `max` mergeplan).
### Allowlists
Sometimes you might want to override the blocklist definitions and always allow
certain domains to access your instance. That's what allowlists are for.
Allowlists can be any in format supported by `blocklist_urls_sources` but will
always set the severity to 'noop'.
An allowlist can contain just the `domain` field and a set of domains, but can
also contain other fields if you want to add public or private comments, for
example.
You can also allow domains on the commandline by using the `-A` or `--allow`
flag and providing the domain name to allow. You can use the flag multiple
times to allow multiple domains.
The allowed domains will be included in the final merged list of domains that
gets exported if you choose to save the mergelist to a file.
## More advanced configuration ## More advanced configuration
For a list of possible configuration options, check the `--help` and read the For a list of possible configuration options, check the `--help` and read the