mirrors/fediverse-blocklists
1
0
Fork 0
mirror of https://codeberg.org/oliphant/blocklists.git synced 2024-11-03 15:59:29 +00:00
Code Issues Projects Releases Packages Wiki Activity
fediverse-blocklists/RUNNING.md
Oliphant bd249ccd1b add config file edit option
2023-05-11 20:08:18 +00:00

3.5 KiB
Raw Blame History

Running the Blocklists

  1. Setup Fediblockhole
python3 -m pip install fediblockhole
  1. Clone this Repo
git clone https://codeberg.org/oliphant/blocklists.git /opt/fediblockhole
# optional: create folders for local scripts and secret config
# mkdir /opt/fediblockhole/local && mkdir /opt/fediblockhole/secretconfig
  1. Execute /opt/fediblockhole/fedisync.sh

That's it. Blocklists will be written to the blocklists folder.

You can use local and secretconfig as subfolders that aren't tracked by git to create your own versions of these scripts and config.

  1. 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.

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.

Configuration

The list of blocklist sources can be found in the /config/pull.conf.toml.

These initial sources are pulled down, with each of them being saved as an intermediate file.

Note: If you want to include the public_description, modify the /config/pull.all.conf.toml 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 or pull.all.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.

Generate files with descriptions

Edit the fedisync.sh file, and where you see as follows:

PULLCONFIG="/opt/fediblockhole/config/pull.conf.toml" # default, pull sources WITHOUT public_description
#PULLCONFIG="/opt/fediblockhole/config/pull.all.conf.toml" # pull down all sources WITH public_description

Comment out the first line and uncomment the second. Then run fedisync.sh as normal. The resulting files will have public_comment populated.

Alternately, edit pull.conf.toml as follows to uncomment the 'public_comment' row:

#import_fields = ['reject_media', 'reject_reports', 'obfuscate']
import_fields = ['public_comment', 'reject_media', 'reject_reports', 'obfuscate']

Pushing to Your Own Server

If you want to push these blocks to your own server, that's an option, too.

An example of this is in fedisync-push.sh. You can copy it to /local/fedisync-push.sh and modify it. If you want to push to a git repo, that references fedisync-git.sh. If you want to automatically sync a merged or list to your own server, the fedisync-example-server.sh script should be modified for your use.

You will need a very permissive API key created for your server to allow the push script to talk to it.

By default, this is configured to downgrade any suspensions to silence while there are follow relationships on your server against a given block.

Note that fedisync-push.sh won't push to any servers at all until you update the API key and the configuration for it.