- Nix 69.5%
- Python 17.4%
- TypeScript 5.8%
- JavaScript 2.8%
- Shell 2%
- Other 2.5%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
Kiara Grouwstra
69b725c920
addresses #1124's listed follow-ups: - restore redis backups - make `api/` defer caching to nix - rotate valkey credentials by openbao database secrets engine Co-authored-by: Kiara Grouwstra <kiara.grouwstra@gmail.com> Reviewed-on: fediversity/fediversity#1154 |
||
| .forgejo | ||
| api | ||
| checks | ||
| examples | ||
| keys | ||
| nix | ||
| nix-module-form | ||
| npins | ||
| panel | ||
| src | ||
| .envrc | ||
| .gitignore | ||
| default.nix | ||
| flake.lock | ||
| flake.nix | ||
| LICENSE | ||
| README.md | ||
| shell.nix | ||
| treefmt.nix | ||
| ty.toml | ||
The Fediversity project
This repository contains all the code and code-related files having to do with the Fediversity project.
Goals
Decentralise the operational responsibility for social media. Enable a more robust market of hosting providers, by making it easy to migrate operations and data to different providers.
Note that Fediversity is not about self-hosting. There already exist solutions for self-hosting, but they're not suitable for what we're trying to do. The ones we're aware of require substantial technical knowledge and time commitment by system-operators, especially for scaling to thousands of users. Not everyone has the expertise and time to run their own server.
Status: in development
see our:
Interactions
To reach these goals, we aim to implement the following interactions between actors (depicted with rounded corners) and system components (see the glossary, depicted with rectangles).
Actors
-
Fediversity project team
The group working on this repository. We are creating the deployment workflows and service configurations.
The project partners for Fediversity are:
Refer to fediversity.eu for more details about the project.
-
Hosting provider
They provide and maintain the physical infrastructure, and run the software in this repository, through which operators interact with their deployments. Hosting providers are technical administrators for these deployments, ensuring availability and appropriate performance.
We target small- to medium-scale hosting providers with 20+ physical machines.
We will provide a checklist and tips and tricks for starting new small-scale hosting providers.
-
Operator
They select the applications they want to run (Mastodon, Pixelfed, Matrix, Nextcloud, Immich etc.). They don't need to own hardware or deal with operations. Operators administer their services in a non-technical fashion, e.g. as moderators. They pay the hosting provider for registering a domain name, maintaining physical resources, and monitoring deployments.
What is always included in the offering is a domain name and e-mail.
Operators also function as first level support for their users.
-
User
They are individuals that are not necessarily affiliated with any organisation. They register an account on services (e.g. Mastodon) run by the operators, and e.g. post content. Users don't need to administrate anything.
The Fediversity offering is aimed at one or two operators servicing 1 to 100 users. Where one hosting provider has to be able to scale to at least 1000 of operators.
Glossary
-
A collection of social networking applications that can communicate with each other using a common protocol.
-
Application
User-facing software run fully automated by the hosting provider for an operator.
-
Configuration
A collection of settings for a machine running NixOS.
Example: Configurations are deployed to VMs or containers.
-
Provision
Make a resource, such as a virtual machine, available for use.
-
Deploy
Put software, such as applications, onto computers. The software includes technical configuration that links software components. Most user-facing configuration remains untouched by the deployment process.
-
Migrate
Move service configurations and deployment state, including user data, from one hosting provider to another.
Migrations will trigger (significant amount of, e.g. days) service unavailability but no data loss.
-
Runtime backend
A type of digital environment one can run operating systems such as NixOS on, e.g. bare-metal, a hypervisor, or a container runtime.
-
Runtime environment
The thing a deployment runs on, an interface against which the deployment is working. See runtime backend.
-
Runtime config
Configuration logic specific to a runtime backend, e.g. how to deploy, how to access object storage.
Development
All the code made for this project is freely licenced under EUPL. This means, anyone can use the work here to learn from it or change it according to their needs. You can even read up on development proceedings.
Contact the project team if you have questions or suggestions, or if you're interested in using Fediversity software for your operations:
- E-mail: mailto:contact@fediversity.eu
- Mastodon: https://mastodon.fediversity.eu/@fediversity
Content of this repository
Most of the directories in this repository have their own README going into more details as to what they are for. As an overview:
-
keys/contains the public keys of the contributors to this project as well as the systems that we administrate. -
panel/contains the code of our front-end. -
src/contains source code handling deployments.
Usage
Loading the nix shell should install a pre-commit hook.