fep

FEP-67ff: FEDERATION.md

Summary

FEDERATION.md is a file containing information necessary for achieving interoperability with a federated service. It was originally proposed by Darius Kazemi on SocialHub forum in Documenting federation behavior in a semi-standard way? topic.

Requirements

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC-2119.

Structure

The FEDERATION.md file can have arbitrary structure and content. The only requirements are:

• It MUST be a valid Markdown document.
• It MUST be located in the root of a project’s code repository. If project’s documentation is located in another place, the FEDERATION.md file may contain a link to that location.
• It SHOULD include a list of implemented federation protocols.
• It SHOULD include a list of supported Fediverse Enhancement Proposals (FEPs).

Template

(This section is non-normative.)

# Federation

## Supported federation protocols and standards

- [ActivityPub](https://www.w3.org/TR/activitypub/) (Server-to-Server)
- [WebFinger](https://webfinger.net/)
- [Http Signatures](https://datatracker.ietf.org/doc/html/draft-cavage-http-signatures)
- [NodeInfo](https://nodeinfo.diaspora.software/)

## Supported FEPs

- [FEP-f1d5: NodeInfo in Fediverse Software](https://codeberg.org/fediverse/fep/src/branch/main/fep/f1d5/fep-f1d5.md)

## ActivityPub

<!-- Describe activities and extensions. -->

## Additional documentation

<!-- Add links to documentation pages. -->

Implementations

• gathio
• Streams
• Smithereen
• Mastodon
• Hometown
• Mitra
• Emissary
• Vervis
• WordPress
• Postmarks
• Bovine in repo and the symlink
• BookWyrm
• Hatsu
• tootik
• Bridgy Fed
• Friendica
• PieFed
• Akkoma
• Iceshrimp.NET
• Forte
• NeoDB
• FIRM
• Vernissage
• apkit
• Tvmarks
• Manyfold

References

• Darius Kazemi, Documenting federation behavior in a semi-standard way?, 2020
• S. Bradner, Key words for use in RFCs to Indicate Requirement Levels, 1997

Copyright

CC0 1.0 Universal (CC0 1.0) Public Domain Dedication

To the extent possible under law, the authors of this Fediverse Enhancement Proposal have waived all copyright and related or neighboring rights to this work.

This site is open source. Improve this page.