mirrors/fuwuqi
1
0
Fork 1
mirror of https://git.exozy.me/a/fuwuqi.git synced 2024-11-22 15:11:01 +00:00
Code Issues Projects Releases Packages Wiki Activity

Improve README

Browse source
This commit is contained in:
Anthony Wang 2023-01-18 01:48:18 -05:00
parent 6327ae546d
commit 9bac506561
No known key found for this signature in database
GPG key ID: 42A5B952E6DD8D38
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -4,6 +4,12 @@ Fuwuqi (fúwùqì or 服务器 means "server" in Chinese) is a useless C2S Activ
## Configuration ## 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. First, clone this repo on your server and your client device.
Now, generate an RSA keypair on 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 ## 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) 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)