A Nostr relay docker image package which filter content based on content type (SFW/NSFW), user type, language, hate speech (toxic comment), sentiment, topic, and various rules.
This docker image consists of several software packages:
- atrifat/nostr-filter (customized/fork of imksoo/nostr-filter) as frontend filter relay
- atrifat/nostr-monitoring-tool as content classification tool
- hoytech/strfry as backend relay
Several dependencies including atrifat/language-detector-api, atrifat/nsfw-detector-api, atrifat/hate-speech-detector-api, atrifat/sentiment-analysis-api, atrifat/topic-classification-api are required depend on the features that were enabled.
A public demo (beta/test) relay is available on wss://nfrelay.app or ws://nfrelay6saohkmipikquvrn6d64dzxivhmcdcj4d5i7wxis47xwsriyd.onion (TOR Onion Hidden Service).
Check USAGE.md document for instructions on how to use nostr-filter-relay as Nostr users.
A relay software package that filter note (kind: 1) contents in various category such as:
- NSFW/SFW content detection
- Language detection
- User type filtering (Nostr user/non bridged user, activitypub bridged user)
- Hate speech (Toxic comment) detection
- Sentiment analysis
- Topic classification
- All other features included in atrifat/nostr-filter and atrifat/nostr-monitoring-tool
nostr-filter-relay use NIP-32 event structure while deprecating old structure event (kind: 9978) (since v0.4.0 and later version).
-
nostr-filter-relay is docker image that will run several softwares: atrifat/nostr-monitoring-tool, atrifat/nostr-filter, and hoytech/strfry relay in launch script at startup.
-
nostr-monitoring-tool is classification tool that fetch and subscribe notes (kind: 1) from various relays. It will process every notes (extraction of image url, text preprocessing) that were seen and send them into external AI classification tool. Currently, it will send processed notes content into NSFW Detector API instance (using atrifat/nsfw-detector-api), Language Detector API instance (using atrifat/language-detector-api or LibreTranslate), Hate Speech Detector API instance (using atrifat/hate-speech-detector-api), Sentiment Analysis API instance (using atrifat/sentiment-analysis-api), and Topic Classification API instance (using atrifat/topic-classification-api). All five API services will give classification results (SFW/NSFW classification, Language classfication, Toxic classification, Sentiment Analysis, Topic Classification) that will be saved as NIP-32 event (kind: 1985) or legacy custom kind 9978 in local strfry relay that has already been running. Data format is shown in atrifat/nostr-monitoring-tool repository.
Basic Data flow: Source Relays (notes) -> nostr-monitoring-tool (connect to external API for classification) -> local strfry
-
Now, using classification data (kind: 1985 or 9978) saved in local strfry relay, atrifat/nostr-filter will act as proxy relay and intercept any REQ from nostr clients and forward them into local strfry relay. Local strfry relay will respond as usual by giving events based on REQ data back to nostr-filter. Before sending events back to nostr clients, nostr-filter will check events from local strfry whether it has classification data (kind: 1985 or 9978) or not. For example, users set nostr-filter-relay parameters to only gives notes which has "English" language then nostr-filter will only gives those notes based on language classification data. Any non "English" notes will be skipped.
Basic Data flow: Nostr clients <-> nostr-filter (act like frontend proxy) <-> local strfry
-
Finally, Nostr clients will get filtered events (example: real data from strfry are 2000 notes but filtered into 1800 "english" notes) and show the notes to users.
The following softwares are required if you want to run your own nostr-filter-relay.
- Docker
- Personal instance of atrifat/nsfw-detector-api. Check atrifat/nsfw-detector-api Github repository for more instructions.
- Personal instance of atrifat/language-detector-api or LibreTranslate. Check atrifat/language-detector-api or LibreTranslate Github repository for more instructions.
- Personal instance of atrifat/hate-speech-detector-api. Check atrifat/hate-speech-detector-api Github repository for more instructions.
- Personal instance of atrifat/sentiment-analysis-api. Check atrifat/sentiment-analysis-api Github repository for more instructions.
- Personal instance of atrifat/topic-classification-api. Check atrifat/topic-classification-api Github repository for more instructions.
You can start by cloning this repository:
git clone https://github.com/atrifat/nostr-filter-relay
cd nostr-filter-relayBefore running nostr-filter-relay, make sure you have already configured your own personal instance of atrifat/nsfw-detector-api, atrifat/language-detector-api or LibreTranslate, atrifat/hate-speech-detector-api, atrifat/sentiment-analysis-api, and atrifat/topic-classification-api. You don't have to run all of them only if you enable classification for certain task (Example: NSFW detection only).
Copy .env.example into .env file and change the configuration according to your own settings.
If you don't want to build docker image locally, you can use the published version in ghcr.io/atrifat/nostr-filter-relay.
Run it:
docker run --init --env-file .env -p 7860:7860 -it ghcr.io/atrifat/nostr-filter-relay:mainor run it in the background (daemon):
docker run --init --env-file .env -p 7860:7860 -it --name nostr-filter-relay -d ghcr.io/atrifat/nostr-filter-relay:mainStart building the docker image:
docker build -t nostr-filter-relay -f Dockerfile .You can start running nostr-filter-relay
docker run --init --env-file .env -p 7860:7860 -it nostr-filter-relayor run it in the background (daemon):
docker run --init --env-file .env -p 7860:7860 -it --name nostr-filter-relay -d nostr-filter-relayDevelopment of nostr-filter-relay has been supported by OpenSats - Fifth Nostr Grant - July 2024.
You can also support this project by:
- ⭐ Starring the repo, reporting issue, or sending the pull requests.
- ⚡️ Sending some sats or paying my tea to my lightning address: [email protected]
MIT License
Copyright (c) 2023 Rif'at Ahdi Ramadhani
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Rif'at Ahdi Ramadhani (atrifat)