No Description

Benton Edmondson dd5d523732 rename from mimicry to servitor 1 year ago
.vscode dd5d523732 rename from mimicry to servitor 1 year ago
ansi d652b98737 Delete util 1 year ago
client dd5d523732 rename from mimicry to servitor 1 year ago
config dd5d523732 rename from mimicry to servitor 1 year ago
feed dd5d523732 rename from mimicry to servitor 1 year ago
gemtext dd5d523732 rename from mimicry to servitor 1 year ago
history 6928d069ff Globally reformat with go fmt 1 year ago
hypertext dd5d523732 rename from mimicry to servitor 1 year ago
jtp dd5d523732 rename from mimicry to servitor 1 year ago
markdown dd5d523732 rename from mimicry to servitor 1 year ago
mime 6928d069ff Globally reformat with go fmt 1 year ago
object dd5d523732 rename from mimicry to servitor 1 year ago
plaintext dd5d523732 rename from mimicry to servitor 1 year ago
pub dd5d523732 rename from mimicry to servitor 1 year ago
splicer dd5d523732 rename from mimicry to servitor 1 year ago
style dd5d523732 rename from mimicry to servitor 1 year ago
ui dd5d523732 rename from mimicry to servitor 1 year ago
.gitignore dd5d523732 rename from mimicry to servitor 1 year ago
go.mod dd5d523732 rename from mimicry to servitor 1 year ago
go.sum 97742ab7bc implemented package config 1 year ago
html.md 2e11dde7d8 Backing up everything out of paranoia 2 years ago
implementation.md 2e11dde7d8 Backing up everything out of paranoia 2 years ago
main.go dd5d523732 rename from mimicry to servitor 1 year ago
notes.md 003cb61cfd Added markdown (github-flavored) rendering support 2 years ago
readme.md e2f1bd3352 readme: Add first draft 1 year ago

readme.md

Servitor

A command line, RSS-style reader for the fediverse.

// image

  • Works with fediverse software such as Mastodon, Lemmy, PeerTube, and more: This browser works with all fediverse software that implements ActivityPub. You can view and subscribe to microblogs (like Linus Torvalds @torvalds@social.kernel.org), video channels (like Luke Smith @luke@videos.lukesmith.xyz), subs (like RPGMemes @rpgmemes@ttrpg.network), and hashtags (like tweesecake.social's #linux) all in the same reader.
  • Doesn't require a server: This browser does not rely on you having a server, so you don't have to host your own server or find another one to rely on.
  • Sidesteps defederation politics: Posts are always pulled directly from their source site, so you are not affected by servers blocking each other.
  • Keeps your subscriptions private: Just like an RSS reader, subscriptions are stored locally, so you can subscribe to people without sending them follow requests.

Usage

Configuration

The config file is located at ~/.config/servitor/config.toml.

[feeds]
# each entry is list of profiles to subscribe to
linux = [ # open with `servitor feed linux`
    "@torvalds@social.kernel.org",
    "@luke@videos.lukesmith.xyz",
    "@thelinuxexperiment@tilvids.com",
]
dnd = [ # open with `servitor feed dnd`
    "@rpgmemes@ttrpg.network",
    "@dnd@lemmy.world",
]

[media]
# the command that is called to open external media
# %u is automatically substituted with the url, %m is substituted with the mime type
hook = [ "xdg-open", "%u" ]

Where to Find Content to Follow

Please submit a PR if you know of another good resource.

A Brief Overview of ActivityPub

For the purpose of this browser, the fediverse can be thought of as a collection of internet forums that use a shared protocol called ActivityPub. Instead of serving content over text/html, they serve their content over application/activity+json, which provides for higher-level semantics such as comment sections, retweets, etc. Just like conventional forums, each site has a different moderation policy, and the administrators of each site have complete control over the moderation of that site. Unlike conventional internet forums, the fediverse allows users from one site to interact with (like, follow, comment on, etc) users and posts on another site, assuming the administrators of the both sites permit the interaction.

Supported Markup Formats

Servitor can render posts published in:

Dependencies

I tried to minimize the amount of dependencies used. They are: