fedimut/README.md
2024-02-29 00:10:45 +01:00

1.7 KiB

fedimut

small tool to keep a list of mutuals on the fediverse

mutuals

turns out being "mutuals" means something on fedi, especially for small instances relying on federated interactions!

since following means subscribing to updates, mutuals are the only people i can be sure may read my posts, and of which i can be sure i'm reading all posts

lists

lists are an incredible tool to keep more organized timelines, however it's quite a hassle to keep them sorted and updated

the solution

fedimut comes to the rescue!

schedule it on your pc or your vps to run periodically: it will fetch your mutuals list, remove all users which are no longer mutuals and add any new mutual you made in the meantime

simple and easy!

usage

right now it's super crude: you must pass <HOMESERVER> <AUTH_TOKEN> <YOUR_USER_ID> as cli arguments to make it work, but next versions may include session storage and user_id resolution

note that user_id is your underlying id, not the fully qualified name!

authentication

the easy way is to steal an auth token from your browser (check any request's headers), but the proper way is to follow Mastodon's Oauth flow

  1. if you already have an application (client_id and client_secret) skip this, otherwise register one agains /api/v1/apps
  2. request access by visiting /oauth/authorize from a logged-in browser passing your application's client_id
  3. with the received code, POST again against /oauth/token but from your application, requesting a proper auth token from your given auth code

and done! received access_token is ready to use