2023-04-30 23:27:42 +02:00
# Running the Blocklists
1. Setup Fediblockhole
```bash
python3 -m pip install fediblockhole
```
2. Clone this Repo
```bash
2023-05-01 03:05:00 +02:00
git clone https://codeberg.org/oliphant/blocklists.git /opt/fediblockhole
2023-05-01 04:40:53 +02:00
# optional: create folders for local scripts and secret config
# mkdir /opt/fediblockhole/local && mkdir /opt/fediblockhole/secretconfig
2023-04-30 23:27:42 +02:00
```
3. Execute
2023-05-01 03:05:00 +02:00
`/opt/fediblockhole/fedisync.sh`
2023-04-30 23:27:42 +02:00
2023-04-30 23:32:40 +02:00
That's it. Blocklists will be written to the `blocklists` folder.
2023-04-30 23:27:42 +02:00
You can use `local` and `secretconfig` as subfolders that aren't tracked by git to create your own versions of these scripts and config.
4. Optional
`./fedisync-push.sh`
This will sync up a specified blocklist (any blocklist you want) to a specified destination. This is not required to generate blocklists.
2023-05-01 01:00:15 +02:00
For more information on how to configure the push file, or a greater explanation of the fundamentals of this process, see [How to Sync up Blocklist Changes From Trusted Sources ](https://writer.oliphant.social/oliphant/how-to-sync-up-blocklist-changes-from-trusted-sources ).
2023-05-01 08:29:37 +02:00
---
## Configuration
The list of blocklist sources can be found in the [/config/pull.conf.toml ](/oliphant/blocklists/src/branch/main/config/pull.conf.toml ).
These initial sources are pulled down, with each of them being saved as an intermediate file.
The `fedisync.sh` script renames each of these source lists to a more friendly name (like mastodon.social.csv)
The remaining steps are performed on these sourcefiles, not pulled from urls.
If you customize the list of sources in `pull.conf.toml` you should also update them in the various `config/*.conf.toml` files as needed.
You will likely also need to customize the `fedisync.sh` to your needs as well if you make these changes.
