aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAnthony Wang2023-01-18 01:48:18 -0500
committerAnthony Wang2023-01-18 01:48:18 -0500
commit9bac506561ee0c301a9e84e124d716fed9d7a08a (patch)
tree84542409dc8c5a3fe383ee06883e4253de302504
parent6327ae546de9d715e7345e37aabdcebae135e2f0 (diff)
Improve README
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index 55d9db1..217411a 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,12 @@ Fuwuqi (fúwùqì or 服务器 means "server" in Chinese) is a useless C2S Activ
## Configuration
+You will need:
+1. 1x server with a domain name and reverse proxy
+2. 1x client device (can be same as server)
+3. 1x brain fluent in Python and ActivityPub
+4. 1x pain tolerance
+
First, clone this repo on your server and your client device.
Now, generate an RSA keypair on your client device:
@@ -20,7 +26,7 @@ That wasn't so bad, was it? (sobbing sounds)
## Usage
-Alright, time for the real deal. Start up `python server.py` on your server. If you want to customize the port or whatever, just change the source code.
+Alright, time for the real deal. Start up `python server.py` on your server, and reverse-proxy it so you actually have TLS. If you want to customize the port or whatever, just change the source code.
Now on your client device, open up your favorite C2S ActivityPub client... oh wait... there aren't any! Welp, you'll just have to settle for reading the [AP spec](https://www.w3.org/TR/activitypub/), writing some homemade JSON, and figuring out how `python client.py` works. That's rough, buddy. You'll have to learn how to manually write `Note`s, manually accept follow requests, and more! You can find some examples in this repo. HTTP signatures are generated client-side, for no good reason other than it works. If you want to view your unread messages, just `curl` your inbox. Easy as that. (screaming in pain sounds)