kiara/Fediversity
1
0
Fork 0
forked from Fediversity/Fediversity
Code Pull requests Activity

add to the glossary as per ZHF session (#340)

Browse source 
points of attention (compared to ZHF pad):

- nouns vs verbs (feel free to improve!)
- some phrasing differences
  - changed services to applications
  - unified host to runtime environment as per diagram
- distinguish actors using rounded corners

Reviewed-on: Fediversity/Fediversity#340
Reviewed-by: Valentin Gagarin <valentin.gagarin@tweag.io>
This commit is contained in:
Kiara Grouwstra 2025-06-02 11:43:31 +02:00
parent ac66b9d3c6
commit afc7ad2b88
1 changed files with 24 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -14,6 +14,12 @@ There already exist solutions for self-hosting, but they're not suitable for wha
The ones we're aware of require substantial technical knowledge and time commitment by operators, especially for scaling to thousands of users. The ones we're aware of require substantial technical knowledge and time commitment by operators, especially for scaling to thousands of users.
Not everyone has the expertise and time to run their own server. Not everyone has the expertise and time to run their own server.
## Interactions
To reach these goals, we aim to implement the following interactions between [actors](#actors) (depicted with rounded corners) and system components (see the [glossary](#glossary), depicted with rectangles).
![](https://git.fediversity.eu/Fediversity/meta/raw/branch/main/architecture-docs/interactions.svg)
## Actors ## Actors
- Fediversity project team - Fediversity project team
@ -57,11 +63,11 @@ Not everyone has the expertise and time to run their own server.
- [Fediverse](https://en.wikipedia.org/wiki/Fediverse) - [Fediverse](https://en.wikipedia.org/wiki/Fediverse)
A collection of social networking services that can communicate with each other using a common protocol. A collection of social networking applications that can communicate with each other using a common protocol.
- Service - Application
A Fediverse application run by the hosting provider for an operator. User-facing software (e.g. from Fediverse) run by the hosting provider for an operator.
- Configuration - Configuration
@ -73,11 +79,11 @@ Not everyone has the expertise and time to run their own server.
Make a resource, such as a virtual machine, available for use. Make a resource, such as a virtual machine, available for use.
> Example: We use [Proxmox](https://www.proxmox.com) to provision VMs for services run by operators. > Example: We use [Proxmox](https://www.proxmox.com) to provision VMs for applications run by operators.
- Deploy - Deploy
Put software, such as services, onto computers. Put software, such as applications, onto computers.
The software includes technical configuration that links software components. The software includes technical configuration that links software components.
Most user-facing configuration remains untouched by the deployment process. Most user-facing configuration remains untouched by the deployment process.
@ -85,7 +91,7 @@ Not everyone has the expertise and time to run their own server.
- Migrate - Migrate
Move service configurations and user data to a different hosting provider. Move service configurations and deployment state, including user data, from one hosting provider to another.
- [NixOps4](https://github.com/nixops4/nixops4) - [NixOps4](https://github.com/nixops4/nixops4)
@ -103,6 +109,18 @@ Not everyone has the expertise and time to run their own server.
> Example: We need a resource provider for obtaining deployment secrets from a database. > Example: We need a resource provider for obtaining deployment secrets from a database.
- 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 ## Development
All the code made for this project is freely licenced under [EUPL](https://en.m.wikipedia.org/wiki/European_Union_Public_Licence). All the code made for this project is freely licenced under [EUPL](https://en.m.wikipedia.org/wiki/European_Union_Public_Licence).