@ -25,10 +25,10 @@ Place a `config.json` file in the same directory that looks like this: (below ar
"brainbaking.com",
"jefklakscodex.com"
],
"blacklist": [
"denylist": [
"youtube.com"
],
"whitelist": []
"allowlist": []
}
```
@ -36,7 +36,7 @@ Place a `config.json` file in the same directory that looks like this: (below ar
- `adminEmail`, the e-mail address to send notificaions to. If absent, will not send out mails. **uses 127.0.0.1:25 postfix** at the moment.
- `port`, host: http server params
- `token`: see below, used for authentication
- `blacklist`/`whitelist`: domains from which we do (NOT) send to or accept mentions from. This is usually the domain of the `source` in the receiving mention. **Note**: the blacklist is also used to block outgoing mentions.
- `denylist`/`allowlist`: domains from which we do (NOT) send to or accept mentions from. This is usually the domain of the `source` in the receiving mention. **Note**: the denylist is also used to block outgoing mentions.
- `allowedWebmentionSources`: your own domains which go-jamming is able to receive mentions from. This is usually domain of the `target` in the receiving mention.
If a config file is missing, or required keys are missing, a warning will be generated and default values will be used instead. See `common/config.go`.
@ -204,23 +204,23 @@ Still, spammers always find a way and sometimes even create fake blog posts with
### Mentions _in moderation_
Go-Jamming employs a `whitelist` and `blacklist` system. By default, all mentions end up in a moderation queue, another database that will not pollute the mention db.
Go-Jamming employs a `allowlist` and `denylist` system. By default, all mentions end up in a moderation queue, another database that will not pollute the mention db.
Each mention has to be manually approved. An e-mail to `localhost:25` (a local Postfix) will be sent out with approve/reject links, if configured. Otherwise, the endpoint `/admin/{token}` is the dashboard where you can approve/reject from time to time:
Approved mentions will have their domain added to the whitelist. Rejected mentions will have their domain added to the blacklist.
Approved mentions will have their domain added to the allowlist. Rejected mentions will have their domain added to the denylist.
Read more about how spam moderation works at https://brainbaking.com/post/2022/04/fighting-webmention-and-pingback-spam/
### Manually blacklisting partial domains
### Manually adding partial domains to the denylist
In that case, simply add the domain to the `blacklist` in `config.json`.
In that case, simply add the domain to the `denylist` in `config.json`.
Adding this **manually** will not remove existing spam in your DB! The `-blacklist` flag is there to:
Adding this **manually** will not remove existing spam in your DB! The `-denylist` flag is there to:
1. Automatically add it to the `blacklist` array in the config file;
2. Automatically search the DB for all allowed domains for spam from the blacklist and remove it. (Check for string match on the URL)
1. Automatically add it to the `denylist` array in the config file;
2. Automatically search the DB for all allowed domains for spam from the denylist and remove it. (Check for string match on the URL)
How to use: `./go-jamming -blacklist annoyingspam.com`. This will exit after the above actions. Then you can simply restart the server with `./go-jamming`.
How to use: `./go-jamming -denylist annoyingspam.com`. This will exit after the above actions. Then you can simply restart the server with `./go-jamming`.
