mirror of https://github.com/LemmyNet/lemmy
Merge remote-tracking branch 'yerba/main' into main
commit
16deec7443
@ -1,23 +1,25 @@
|
||||
# Summary
|
||||
|
||||
- [About](about.md)
|
||||
- [Features](about_features.md)
|
||||
- [Goals](about_goals.md)
|
||||
- [Post and Comment Ranking](about_ranking.md)
|
||||
- [Guide](about_guide.md)
|
||||
- [Administration](administration.md)
|
||||
- [Install with Docker](administration_install_docker.md)
|
||||
- [Install with Ansible](administration_install_ansible.md)
|
||||
- [Configuration](administration_configuration.md)
|
||||
- [Backup and Restore](administration_backup_and_restore.md)
|
||||
- [Federation](administration_federation.md)
|
||||
- [Contributing](contributing.md)
|
||||
- [Docker Development](contributing_docker_development.md)
|
||||
- [Local Development](contributing_local_development.md)
|
||||
- [Tests](contributing_tests.md)
|
||||
- [Federation Development](contributing_federation_development.md)
|
||||
- [Websocket/HTTP API](contributing_websocket_http_api.md)
|
||||
- [Federation Overview](contributing_federation_overview.md)
|
||||
- [ActivityPub API Outline](contributing_apub_api_outline.md)
|
||||
- [Theming Guide](contributing_theming.md)
|
||||
- [About](about/about.md)
|
||||
- [Features](about/features.md)
|
||||
- [Goals](about/goals.md)
|
||||
- [Post and Comment Ranking](about/ranking.md)
|
||||
- [Guide](about/guide.md)
|
||||
- [Administration](administration/administration.md)
|
||||
- [Install with Docker](administration/install_docker.md)
|
||||
- [Install with Ansible](administration/install_ansible.md)
|
||||
- [Configuration](administration/configuration.md)
|
||||
- [Backup and Restore](administration/backup_and_restore.md)
|
||||
- [Federation](federation/federation.md)
|
||||
- [Federation Overview](federation/overview.md)
|
||||
- [Administration](federation/administration.md)
|
||||
- [Resources](federation/resources.md)
|
||||
- [Lemmy Protocol](federation/lemmy_protocol.md)
|
||||
- [Contributing](contributing/contributing.md)
|
||||
- [Docker Development](contributing/docker_development.md)
|
||||
- [Local Development](contributing/local_development.md)
|
||||
- [Theming Guide](contributing/theming.md)
|
||||
- [Tests](contributing/tests.md)
|
||||
- [Websocket/HTTP API](contributing/websocket_http_api.md)
|
||||
- [Federation Development](contributing/federation_development.md)
|
||||
- [Lemmy Council](lemmy_council.md)
|
||||
|
@ -1,6 +1,6 @@
|
||||
# Ansible Installation
|
||||
|
||||
This is the same as the [Docker installation](administration_install_docker.md), except that Ansible handles all of it automatically. It also does some extra things like setting up TLS and email for your Lemmy instance.
|
||||
This is the same as the [Docker installation](install_docker.md), except that Ansible handles all of it automatically. It also does some extra things like setting up TLS and email for your Lemmy instance.
|
||||
|
||||
First, you need to [install Ansible on your local computer](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html) (e.g. using `sudo apt install ansible`) or the equivalent for you platform.
|
||||
|
@ -0,0 +1,14 @@
|
||||
# Federation
|
||||
|
||||
Lemmy uses the ActivityPub protocol (a W3C standard) to enable federation between different servers (often called instances). This is very similar to the way email works. For example, if you use gmail.com, then you can't just send mails to other gmail.com users, but also to yahoo.com, yandex.ru and so on. Email uses the SMTP protocol to achieve this, so you can think of ActivityPub as "SMTP for social media". The amount of different actions possible on social media (post, comment, like, share, etc) means that ActivityPub is much more complicated than SMTP.
|
||||
|
||||
As with email, ActivityPub federation happens only between servers. So if you are registered on `enterprise.lemmy.ml`, you only connect to the API of `enterprise.lemmy.ml`, while the server takes care of sending and receiving data from other instances (eg `voyager.lemmy.ml`). The great advantage of this approach is that the average user doesn't have to do anything to use federation. In fact if you are using Lemmy, you are likely already using it. One way to confirm is by going to a community or user profile. If you are on `enterprise.lemmy.ml` and you see a user like `@nutomic@voyager.lemmy.ml`, or a community like `!main@ds9.lemmy.ml`, then those are federated, meaning they use a different instance from yours.
|
||||
|
||||
One way you can take advantage of federation is by opening a different instance, like `ds9.lemmy.ml`, and browsing it. If you see an interesting community, post or user that you want to interact with, just copy its URL and paste it into the search of your own instance. Your instance will connect to the other one (assuming the allowlist/blocklist allows it), and directly display the remote content to you, so that you can follow a community or comment on a post. Here are some examples of working searches:
|
||||
|
||||
- `!main@lemmy.ml` (Community)
|
||||
- `@nutomic@lemmy.ml` (User)
|
||||
- `https://lemmy.ml/c/programming` (Community)
|
||||
- `https://lemmy.ml/u/nutomic` (User)
|
||||
- `https://lemmy.ml/post/123` (Post)
|
||||
- `https://lemmy.ml/comment/321` (Comment)
|
@ -1,4 +1,6 @@
|
||||
# Activitypub API outline
|
||||
# Lemmy Federation Protocol
|
||||
|
||||
The Lemmy Protocol (or Lemmy Federation Protocol) is a strict subset of the [ActivityPub Protocol](https://www.w3.org/TR/activitypub/). Any deviation from the ActivityPub protocol is a bug in Lemmy or in this documentation (or both).
|
||||
|
||||
This document is targeted at developers who are familiar with the ActivityPub and ActivityStreams protocols. It gives a detailed outline of the actors, objects and activities used by Lemmy.
|
||||
|
@ -1,4 +1,4 @@
|
||||
# Federation
|
||||
# Federation Overview
|
||||
|
||||
|
||||
This document is for anyone who wants to know how Lemmy federation works, without being overly technical. It is meant provide a high-level overview of ActivityPub federation in Lemmy. If you are implementing ActivityPub yourself and want to be compatible with Lemmy, read our [ActivityPub API outline](contributing_apub_api_outline.md).
|
@ -0,0 +1,22 @@
|
||||
# ActivityPub Resources
|
||||
|
||||
## Official Documents
|
||||
|
||||
- [ActivityPub standard](https://www.w3.org/TR/activitypub/)
|
||||
- [Activitypub vocabulary](https://www.w3.org/TR/activitystreams-vocabulary/)
|
||||
|
||||
## Explanations
|
||||
|
||||
- [ActivityPub - one protocol to rule them all?](https://schub.io/blog/2018/02/01/activitypub-one-protocol-to-rule-them-all.html)
|
||||
- [A highly opinionated guide to learning about ActivityPub](https://tinysubversions.com/notes/reading-activitypub/)
|
||||
- [Activitypub implementers guide](https://socialhub.activitypub.rocks/t/draft-guide-for-new-activitypub-implementers/479)
|
||||
- [Mastodon Blog: How to implement a basic ActivityPub server](https://blog.joinmastodon.org/2018/06/how-to-implement-a-basic-activitypub-server/)
|
||||
- [Mastodon Blog: Implementing an ActivityPub inbox](https://blog.joinmastodon.org/2018/07/how-to-make-friends-and-verify-requests/)
|
||||
- [Data storage questions](https://socialhub.activitypub.rocks/t/data-storage-questions/579)
|
||||
- [Activitypub as it has been understood](https://flak.tedunangst.com/post/ActivityPub-as-it-has-been-understood)
|
||||
|
||||
## Examples and Libraries
|
||||
|
||||
- [ActivityPub example server](https://github.com/tOkeshu/activitypub-example)
|
||||
- [ActivityStreams crate](https://docs.rs/activitystreams/)
|
||||
- [HTTP Signatures crate](https://git.asonix.dog/Aardwolf/http-signature-normalization)
|
Loading…
Reference in New Issue