Skip to content

Latest commit

 

History

History
105 lines (66 loc) · 4.72 KB

README.md

File metadata and controls

105 lines (66 loc) · 4.72 KB

shepherd

Overview

shepherd is a framework to build content moderation systems.

The output of shepherd is a transaction id list that you can load with an Arweave node, in order to protect your node from storing and serving unwanted material. It uses a simple plugin architecture so that you are in control of what is filtered, and makes creating your own filters easier through the use of these plugins.

If you just want to use the default plugin, skip on

shepherd handles all of the raw content from the weave data, filters out non-media and most invalid data, and passes it on to your filter plugin.

If you decide to create a filter plugin you are not just limited to specific types of adult content (as with the default shepherd-plugin-nsfw), and could in fact filter anything you can build an AI classification filter for, or simpler filters such as blacklist/whitelist a particular app’s content media. It’s up to you as to whether you want to run it, and what you will filter.

The shepherd plugin system

Configuration

You can load plugins by adding them to shepherd.config.json. Currently just the first plugin in the list is used.

The default configuration:

{
	"plugins": [
		"shepherd-plugin-nsfw"
	],
	"lowmem": false
}

Shepherd plugins should be available as npmjs packages, or the build version made available on GitHub or elsewhere to install directly. Under the hood the system just runs npm install <plugin-package> and imports the module. So you can put whatever string you like in there. For example, if you wanted a certain branch from your GitHub repo display-name/repo-name#branch-name.

shepherd-plugin-interfaces

Plugin filters need to conform to the shepherd-plugin-interfaces in order to communicate with the shepherd host software.

Right now the interface is still settling, but this should be more or less it shepherd-plugin-interfaces.ts

The Default Plugin: shepherd-plugin-nsfw

Using the default plugin creates & maintains a strict adult content blacklist.

Notes:

  • Expect false positives. The aim is to have zero adult content get through.
  • This is a work in progress. Bug reports appreciated :-) just open a github issue.

Minimum System Requirements

  • at least 10GB of free disk space
  • windows: no specific requirements
  • linux: swap file or partition must exist. Example: 32GB ram / 64GB swap
  • apple m1 silicon: now fully supported, no specific requirements
  • other arm cpus or macos x86: untested, test reports welcome!

Prerequisites

  1. install docker & docker-compose
  2. copy apps/shepherd.config.json.example to apps/shepherd.config.json
  3. (optional/advanced) create a .env file (e.g. cp .env.example .env)

Install and run

Clone this repo and cd in to the shepherd directory. Configure apps/shepherd.config.json if you need to, then run this command

docker-compose up -d

That's it! There's also start.bat and ./start.sh for your convenience.

Usage

Initial Set Up

On initial start it will take some time (maybe several days for example) to read in and categorize all media files from the permaweb. Expect the server to run hot during this initial phase.

You can check on progress (and potentially errors) using ./run_logs.sh or

docker-compose logs -f

but there's no need to wait for it to sync to the latest block, you can start using the list produced straight away.

Load and Use the Blacklist

Your new blacklist server will expose a list of blacklisted content on http://localhost/blacklist.txt or remotely by opening up port 80 and using your IP address.

You can use this in the CLI start command of your Arweave node by adding the transaction_blacklist_url parameter. For example, if your node & blacklist are running on the same server:

./bin/start mine mining_addr <YOUR-MINING-ADDRESS> transaction_blacklist_url http://localhost/blacklist.txt peer 188.166.200.45 peer 188.166.192.169 peer 163.47.11.64 peer 139.59.51.59 peer 138.197.232.192

Final Thoughts

Your arweave node will automatically refresh and update blacklisted content as the list grows. There should be no more needed to be done.

You can set lowmem to true in your shepherd.config.json if you have created and enlarged your swapfile but are still running out of memory. This will slow down initial sync.

If you find that there are other tasks to be performed, please open a GitHub issue, thanks!