Merge pull request #15 from atrifat/docs-new-relay-domain

docs: new relay domain and tor onion service

README.md

@@ -8,10 +8,9 @@ This docker image consists of several software packages:
 - [atrifat/nostr-monitoring-tool](https://github.com/atrifat/nostr-monitoring-tool) as content classification tool
 - [hoytech/strfry](https://github.com/hoytech/strfry) as backend relay
 
-
 ## Demo
 
-A public demo (beta/test) instance is available on [wss://nostr-id-relay.hf.space](wss://nostr-id-relay.hf.space). There is no guarantee for the uptime, but feel free to test.
+A public demo (beta/test) instance is available on [wss://nfrelay.app](wss://nfrelay.app) or [ws://nfrelay6saohkmipikquvrn6d64dzxivhmcdcj4d5i7wxis47xwsriyd.onion](ws://nfrelay6saohkmipikquvrn6d64dzxivhmcdcj4d5i7wxis47xwsriyd.onion) (TOR Onion Hidden Service).
 
 ## Usage
 

USAGE.md

@@ -2,11 +2,11 @@
 
 ## Basic Usage
 
-nostr-filter-relay can be used and activated as relay for "Global" feed in our Nostr clients. Simply add `wss://nostr-id-relay.hf.space` (public demo relay, or change it into our own nostr-relay-filter url) to our nostr clients and set it to enable reading in "Global" relay settings.
+nostr-filter-relay can be used and activated as relay for "Global" feed in our Nostr clients. Simply add `wss://nfrelay.app` (public demo relay, or change it into our own nostr-relay-filter url) to our nostr clients and set it to enable reading in "Global" relay settings.
 
-If we don't add any parameter (?) behind the url of `wss://nostr-id-relay.hf.space` then it is equal to using relay with parameters using its default values:
+If we don't add any parameter (?) behind the url of `wss://nfrelay.app` then it is equal to using relay with parameters using its default values:
 
-`wss://nostr-id-relay.hf.space/?user=all&lang=all&content=sfw&nsfw_confidence=75&lang_confidence=15&toxic=no&toxic_confidence=75`
+`wss://nfrelay.app/?user=all&lang=all&content=sfw&nsfw_confidence=75&lang_confidence=15&toxic=no&toxic_confidence=75`
 
 Default values above will make relay filter events focus on **"General common users"** by serving **'family-friendly'** note events by default. However, we can customize the parameter (using single or multiple parameters) based on our needs. Check **Examples** to get the gists on how to use nostr-filter-relay.
 
@@ -22,7 +22,7 @@ The following are various examples on how to use nostr-filter-relay which illust
 >
 > **Answer**
 >
-> Add `wss://nostr-id-relay.hf.space`
+> Add `wss://nfrelay.app`
 
 > **Note**
 >
@@ -34,31 +34,31 @@ The following are various examples on how to use nostr-filter-relay which illust
 >
 > **Answer**
 >
-> Add `wss://nostr-id-relay.hf.space/?content=sfw`
+> Add `wss://nfrelay.app/?content=sfw`
 
 > **Note**
 >
 > "I'm ok with whatever content is posted, as long as the post is **tagged** using #nsfw hashtag or **have** any **content-warning**. My nostr clients have already features to give me warning/toggle button for those contents properly, thus i can still view them later if i want. I don't like if those contents **don't have** any **tag** (**untagged**) or any **content-warning** (NIP-36)."
 >
 > **Answer**
 >
-> Add `wss://nostr-id-relay.hf.space/?content=partialsfw`
+> Add `wss://nfrelay.app/?content=partialsfw`
 
 > **Note**
 >
 > "I want to make a **specialized** Nostr client for #nsfw content creator (pornhubstr). I **don't need** any **non #nsfw** content"
 >
 > **Answer**
 >
-> Add `wss://nostr-id-relay.hf.space/?content=nsfw`
+> Add `wss://nfrelay.app/?content=nsfw`
 
 > **Note**
 >
 > "LMAO, YOLO, why bother. I **don't care with whatever** anyone post. Your relay job is only to **aggregate** the contents so i don't have to connect with lots of relays (**save data bandwidth**)."
 >
 > **Answer**
 >
-> Add `wss://nostr-id-relay.hf.space/?content=all`
+> Add `wss://nfrelay.app/?content=all`
 
 ### User Type Filtering Example
 
@@ -68,15 +68,15 @@ The following are various examples on how to use nostr-filter-relay which illust
 >
 > **Answer**
 >
-> Add `wss://nostr-id-relay.hf.space/?user=nostr`
+> Add `wss://nfrelay.app/?user=nostr`
 
 > **Note**
 >
 > "Nostr contents are boring, mostly talk about nostr and bitcoin day and night. Better **only see fedi/mastodon contents**. Hehe, activitypub FTW"
 >
 > **Answer**
 >
-> Add `wss://nostr-id-relay.hf.space/?user=activitypub`
+> Add `wss://nfrelay.app/?user=activitypub`
 
 ### Language Filtering Example
 
@@ -86,15 +86,15 @@ The following are various examples on how to use nostr-filter-relay which illust
 >
 > **Answer**
 >
-> Add `wss://nostr-id-relay.hf.space/?lang=id`
+> Add `wss://nfrelay.app/?lang=id`
 
 > **Note**
 >
 > "我说中文和日文, 私は中国語と日本語で話します" (translated: I speak in **Chinese** and **Japanese**)
 >
 > **Answer**
 >
-> Add `wss://nostr-id-relay.hf.space/?lang=zh,ja`
+> Add `wss://nfrelay.app/?lang=zh,ja`
 
 ### Hate speech (Toxic comments) Filtering Example
 
@@ -104,31 +104,31 @@ The following are various examples on how to use nostr-filter-relay which illust
 >
 > **Answer**
 >
-> Add `wss://nostr-id-relay.hf.space/?toxic=no` (default value: no, valid value: no, yes, all)
+> Add `wss://nfrelay.app/?toxic=no` (default value: no, valid value: no, yes, all)
 
 > **Note**
 >
 > "I don't care whether to see insult, vulgar comment, identity hate, or any toxic comments"
 >
 > **Answer**
 >
-> Add `wss://nostr-id-relay.hf.space/?toxic=all` (default value: no, valid value: no, yes, all)
+> Add `wss://nfrelay.app/?toxic=all` (default value: no, valid value: no, yes, all)
 
 > **Note**
 >
 > "I want to see only insult, vulgar comment, identity hate, or any toxic comments"
 >
 > **Answer**
 >
-> Add `wss://nostr-id-relay.hf.space/?toxic=yes` (default value: no, valid value: no, yes, all)
+> Add `wss://nfrelay.app/?toxic=yes` (default value: no, valid value: no, yes, all)
 
 > **Note**
 >
 > "I don't want to see any insult, vulgar comment, identity hate, or any toxic comments. I want to set minimum probability score to be high (90% minimum score)."
 >
 > **Answer**
 >
-> Add `wss://nostr-id-relay.hf.space/?toxic=no&toxic_confidence=90` (default toxic_confidence: 75, valid value: 0-100)
+> Add `wss://nfrelay.app/?toxic=no&toxic_confidence=90` (default toxic_confidence: 75, valid value: 0-100)
 
 ### Confidence Score Filtering Example
 
@@ -138,23 +138,23 @@ The following are various examples on how to use nostr-filter-relay which illust
 >
 > **Answer**
 >
-> Add `wss://nostr-id-relay.hf.space/?nsfw_confidence=85` (default value: 75, valid value: 0-100)
+> Add `wss://nfrelay.app/?nsfw_confidence=85` (default value: 75, valid value: 0-100)
 
 > **Note**
 >
 > "There are still some **false negative** (NSFW content is classified as Non-NSFW) in your filter relay. I will adjust and **lower** the minimum confidence thresold percentage on my own."
 >
 > **Answer**
 >
-> Add `wss://nostr-id-relay.hf.space/?nsfw_confidence=60` (default value: 75, valid value: 0-100)
+> Add `wss://nfrelay.app/?nsfw_confidence=60` (default value: 75, valid value: 0-100)
 
 > **Note**
 >
 > "Your language detection have lots of **false positive**. I will **adjust** the confidence **thresold** percentage on my own."
 >
 > **Answer**
 >
-> Add `wss://nostr-id-relay.hf.space/?lang_confidence=65` (default value: 15, valid value: 0-100)
+> Add `wss://nfrelay.app/?lang_confidence=65` (default value: 15, valid value: 0-100)
 
 ### Multiple Parameters Filtering Example
 
@@ -164,15 +164,15 @@ The following are various examples on how to use nostr-filter-relay which illust
 >
 > **Answer**
 >
-> Add `wss://nostr-id-relay.hf.space/?lang=en&lang_confidence=85` (default value: 15, valid value: 0-100)
+> Add `wss://nfrelay.app/?lang=en&lang_confidence=85` (default value: 15, valid value: 0-100)
 
 > **Note**
 >
 > "I want to see content from Arabic users. It should be highly accurate, with minimum 90 thresold score. Also, i don't want to see any sensitive content (with minimum thresold score: 50) and activitypub content"
 >
 > **Answer**
 >
-> Add `wss://nostr-id-relay.hf.space/?lang=ar&lang_confidence=90&content=sfw&nsfw_confidence=50&user=nostr` (multiple parameters)
+> Add `wss://nfrelay.app/?lang=ar&lang_confidence=90&content=sfw&nsfw_confidence=50&user=nostr` (multiple parameters)
 
 ### Non Example