Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/letterbook/letterbook

A federated microblogging server, focussed on the admin, moderator, and community experience
https://github.com/letterbook/letterbook

activitypub contributions-welcome csharp federation mastodon microblogging

Last synced: 24 days ago
JSON representation

A federated microblogging server, focussed on the admin, moderator, and community experience

Awesome Lists containing this project

README 

        
# Letterbook



![Letterbook logo](./docs/letterbook-banner-dark.png)



[![Build status badge](https://github.com/Letterbook/Letterbook/actions/workflows/pull-request.yml/badge.svg?branch=main)](https://github.com/Letterbook/Letterbook/actions/workflows/pull-request.yml)

[![Good first issues badge](https://img.shields.io/github/issues-search/letterbook/letterbook?query=is%3Aissue%20is%3Aopen%20label%3A%22ready%20to%20start%22%2C%22good%20first%20issue%22%20&style=flat&logo=github&label=Good%20first%20issue&labelColor=%23404951&color=%2333CB56)](https://github.com/Letterbook/Letterbook/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22%2C%22ready+to+start%22)



Letterbook is a federated microblogging service, implementing ActivityPub. The goal for the project is to make hosting a fediverse server a better and more sustainable experience. We also want to make it a safer and more inclusive space for the people who make the fediverse their social media home. Those are big aspirations, but we have some solid plans about how to start, and [we would love more input about where to go from there](#contributing).



## Features

We don't have an exhaustive list, but we will support many of the features that are already common in the fediverse. You'll be able to post, edit your posts, use hashtags and custom emojis, and migrate accounts, for example.



  

      
For Admins and Ops


  



#### Easy setup for new instances

Letterbook initially deploys as a single executable with simple load-balanced scaling. Aside from ancillary services like object storage and email, 1 server and 1 database is all you need to get up and running. And if you do see huge scale in your future, you can still scale outward to distributed task workers and microservices.



#### Lower cost and complexity

Letterbook doesn't maintain any live state. Everything lives in the database, so there's no need to run a Redis cluster or similar to act as shared state storage. We also expect to have significantly lower compute demands, due to both the architectural choices to avoid expensive infrastructure and system sprawl, and the use of C#, a very high performance compiled language.



#### First class observability

Letterbook is thoroughly instrumented for both automatic and custom telemetry, including robust logging, metrics, and distributed tracing. We also provide out-of-the-box collection and dashboards for our telemetry. You can investigate errors, bugs, and performance issues the same way we the developers would.



  

      
For Moderators


  



#### Local-only posts

Avoid context collapse! You can talk to your users and they can talk to each other, without risking context collapse by exposure to the whole fediverse.



#### Automatically expiring actions

Moderator actions like blocking, muting, and limiting federation will all be able to automatically expire after a set time.



#### Fine grained federation controls

You'll be able to do things like prevent federated posts from appearing in promoted feeds, prevent them from appearing at all without an established follow relationship, hide posts behind a click-through and warning, and defederate without breaking your users follow relationships, in addition to the same basic options as other servers.



#### Other moderator tools

- Keep and share notes

- Audit logs

- Auditable privileged views of non-public posts

- Spam and quality filters

- And more



  

      
For Members


  



#### Frequently requested features

- Quote replies

- Collapse notifications

- Block, limit, and remove replies to your posts

- Propose and accept edits to alt text and content warnings

- Compose multi-post threads

- Save drafts and scheduled posts

- Formatted posts

- Emoji reactions



#### Mastodon apps

We intend to implement the Mastodon API, which will provide support for many existing Mastodon apps. Over time, we expect our features will grow well beyond what Mastodon supports, of course. But until we do, or if those features don't interest you, your current favorite app will still be there for you.



#### Better discoverability

Letterbook will have features like topic detection and topic based feeds. Follow recommendations will also consider topics you express an interest in and friends-of-friends relationships.



#### More sophisticated authoring and following options

We hope to support long form, multi-page posts. We'll also be able to create multiple promoted feeds for your own posts, and have the ability to follow those feeds specifically. If for some strange reason people want to follow your analysis of CVEs and not your fursuit friday posts, that's a doable thing. And you'll eventually be able to co-author posts with other people.



#### Real DMs

We plan to provide a real direct message experience by implementing an XMPP server. If you previously used Jabber, then it's likely that your favorite chat client is ready and waiting for you, better than ever. And if you never stopped, then you probably know that better than we do, and hopefully this is good news for you. You will of course be able to send and receive posts with restricted visibility, just like you do now, so you won't lose access to Mastodon-style direct messages with your contacts.



## Background



All of this is just the beginning of what we have planned for Letterbook. We're very excited about the future, and we get to build it together. If you'd like to know  more about the thought process that went into starting the project, [you can read the blog post](https://jenniferplusplus.com/letterbook/).



## Contributing



> [!TIP]

> To get started developing, see the Quickstart section in the [Contributing Guide](./CONTRIBUTING.md)



Please reach out to let us know you're interested in the project! There are many ways to contribute, it's a lot more than just code. Experience in these areas would be particularly helpful, right now. And this list will only grow over time.



1. User experience research

2. Trust and safety advice

3. Visual design

4. Web UI code

5. Backend C# code

6. Project management

7. Technical communication



## Roadmap



> [!IMPORTANT]

> We use projects to organize the backlog  

> Our current project is the [Single User Preview](https://github.com/orgs/Letterbook/projects/5/views/4)



It might help to put all this in context of what has and hasn't been done already. At this point, we've essentially climbed one mountain, and now we're surveying all of the other mountains we still have ahead of us. The plan is to move toward a product that could be responsibly run in production for a single user, with the goal of supporting large multi-user deployments in the future. We'll learn more from the experience of supporting live workloads, and build more robust tools, features, and performance based on that experience. Right now is a great time to join the project. There's so much that needs to be done, and also a solid foundation to work from.



```mermaid

%%{init: { 'theme': 'default' } }%%

timeline

    section Zero to Federated 🏔️

        ActivityPub & friends       : ActivityStreams types : ActivityPub APIs : Data models and persistance : Webfinger API : HTTP Signatures : Message queue

    section Single user preview 👤

        Posting 🟢                  : Data models ☑️ : Core logic ☑️ : Db Schema ☑️ : APIs ☑️ : Federation : 3rd party APIs 

        Account management 🟢       : Data models ☑️ : Db schema ☑️ : Account creation ☑️ : APIs : Contact management : Password management : Email verification : 3rd party APIs 

        Authn/Authz 🟡              : Data models ☑️ : Password verification ☑️ : Token creation/verification ☑️ : Login/logout/challenge : Claims scheme : OIDC support 

        Feeds 🟢                    : Data models ☑️ : Db schema ☑️ : APIs ☑️ : Populate data ☑️ : 3rd party APIs 

        Moderation 🔴               : Data models : Db schema : APIs : Block : Mute : Suspend : Report : Federation limits : 3rd party APIs 

        Media 🔴                    : Data models : Db schema : 3rd party APIs 

```



Please note that this roadmap is only updated ocassionally. The project's Github issues, and specifically the [Single User Preview board][sup-board] is the best way to keep track of what's planned, in-progress, and completed.



## Maintainers



* [@[email protected]](https://hachyderm.io/@jenniferplusplus)

* [@[email protected]](https://hachyderm.io/@runewake2)

* [@[email protected]](https://enby.life/@hazelnoot)



[sup-board]: https://github.com/orgs/Letterbook/projects/5/views/4