aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAnthony Wang2023-01-18 01:19:53 +0000
committerAnthony Wang2023-01-18 01:19:53 +0000
commit80e5041182782ee9dea5e9aea063c846e168df01 (patch)
tree5325d9ca58170fd94a3eff7f1911e2950bea608e /README.md
parentc2b532982cc27b12041922f5be1a74e60d578542 (diff)
Add static files
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 33 insertions, 1 deletions
diff --git a/README.md b/README.md
index 69626c3..06c228d 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,35 @@
# fuwuqi
-A useless C2S ActivityPub server \ No newline at end of file
+Fuwuqi (fúwùqì or 服务器 means "server" in Chinese) is a useless C2S ActivityPub server for "extremely hardcore" ActivityPub enthusiasts. Craft your own exquisite WebFinger response! Customize your actor object exactly like you want! Hack and extend the 100-line Python server code!
+
+If that sounds like a world of pain, close this webpage now... OK, got that out of the way. Time for some fun!
+
+## Configuration
+
+First, clone this repo on your server.
+
+Now, generate an RSA keypair on your client device:
+```bash
+openssl genrsa -out private.pem 2048
+openssl rsa -in private.pem -outform PEM -pubout -out public.pem
+```
+
+Rename `users/test.jsonld` to your username and pop it open in your favorite text editor. You should change `0.exozy.me` to match your server's domain name, `test` to your username, and the `publicKeyPem` field to the public key you just generated.
+
+Onward! Now open `.well-known/webfinger` in your editor, and modify it similarly.
+
+That wasn't so bad, was it? (sobbing sounds)
+
+## Usage
+
+Alright, time for the real deal. Start up `python main.py` on your server. 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/) and `curl`ing some homemade JSON. That's rough, buddy.
+
+Like and subscribe and enjoy your new "extremely hardcore" ActivityPub server!!! 🎉😎🚀🙃🥳
+
+## Resources
+
+- https://www.w3.org/TR/activitypub/
+- https://blog.joinmastodon.org/2018/06/how-to-implement-a-basic-activitypub-server/
+- https://blog.joinmastodon.org/2018/07/how-to-make-friends-and-verify-requests/