Skip to content

Commit

Permalink
Merge pull request #20 from atrifat/fork-docs
Browse files Browse the repository at this point in the history
docs: update fork documentation and license
  • Loading branch information
atrifat authored Nov 20, 2023
2 parents 5cbbaa0 + 981526e commit 29d5c56
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
1 change: 1 addition & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
MIT License

Copyright (c) 2023 Kirino Minato
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
Expand Down
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,17 @@

Nostr-filter is a user-friendly filtering program designed to improve the management of your Nostr relay server. This program enables you to easily filter out undesired events, block specific users, and limit access from certain IP addresses or ranges. By employing regular expressions for content filtering, a list of public keys for user blocking, and a list of CIDR notations for IP address filtering, you can effortlessly tailor the settings to your preferences and ensure a smooth and optimized experience for your Nostr relay users.

## Fork Differences and Features

[atrifat/nostr-filter](https://github.com/atrifat/nostr-filter) is a custom fork of [imksoo/nostr-filter](https://github.com/imksoo/nostr-filter) which focuses on additional filtering features using [atrifat/nostr-monitoring-tool](https://github.com/atrifat/nostr-monitoring-tool) data such as:

- Language filtering
- SFW/NSFW Content filtering
- Hate speech (Toxic Comments) filtering
- and other features listed in [atrifat/nostr-monitoring-tool](https://github.com/atrifat/nostr-monitoring-tool)

[atrifat/nostr-filter](https://github.com/atrifat/nostr-filter) is also main component of [atrifat/nostr-filter-relay](https://github.com/atrifat/nostr-filter-relay) which act as frontend proxy filter relay.

## Installation

To run `nostr-filter`, you need to have Docker and Docker Compose installed.
Expand Down

0 comments on commit 29d5c56

Please sign in to comment.