FEP-67ff: FEDERATION.md

概要

FEDERATION.mdは、連合サービスとの相互運用性を実現するために必要な情報を含むファイルです。元々はDarius KazemiがSocialHubフォーラムにおいて「半標準化された方法でフェデレーション動作を文書化する方法について」というトピックで提案したものです。

要件

本ドキュメント中で使用される「MUST」「MUST NOT」「REQUIRED」「SHALL」「SHALL NOT」「SHOULD」「SHOULD NOT」「RECOMMENDED」「MAY」「OPTIONAL」の各用語は、RFC-2119で定義された解釈に従うものとします。

構造

FEDERATION.mdファイルは任意の構成と内容を許容します。ただし、以下の要件を満たす必要があります：

• 有効なMarkdown文書形式でなければならない
• プロジェクトのコードリポジトリのルートディレクトリに配置すること。もしプロジェクトドキュメントが別の場所に存在する場合、FEDERATION.mdファイルにはその位置へのリンクを含めることができる
• 実装されているフェデレーションプロトコルの一覧を記載することが望ましい
• Fediverse Enhancement Proposals（FEPs）のうちサポートしている規格のリストを記載することが望ましい

テンプレート

（本セクションは非規範的な内容です）

# 連合サービスについて

## 対応フェデレーションプロトコルおよび標準仕様

- [ActivityPub](https://www.w3.org/TR/activitypub/)（サーバ間通信用）
- [WebFinger](https://webfinger.net/)
- [HTTP署名規格](https://datatracker.ietf.org/doc/html/draft-cavage-http-signatures)
- [NodeInfo](https://nodeinfo.diaspora.software/)

## 対応FEPs一覧

- [FEP-67ff: FEDERATION.md](https://codeberg.org/fediverse/fep/src/branch/main/fep/67ff/fep-67ff.md)

## ActivityPub仕様

<!-- アクティビティと拡張機能についての説明を記載 -->

## 追加ドキュメント

<!-- 関連ドキュメントページへのリンクを追加 -->

実装例

• gathio
• Streams
• Smithereen
• Mastodon
• Hometown
• Mitra
• Emissary
• Vervis
• WordPress
• Postmarks
• Bovine リポジトリ内のドキュメントおよびシンボリックリンク[FEDERATION.md]
• BookWyrm
• Hatsu
• tootik
• Bridgy Fed
• Friendica
• PieFed
• Akkoma
• Iceshrimp.NET
• Forte
• NeoDB
• FIRM
• Vernissage
• apkit
• Tvmarks
• Manyfold
• Cryap
• ActivityPub Fuzzer
• Comments（生ドキュメント）
• Loops
• snac
• squidcity
• badgefed

参考文献

• Darius Kazemi, 半標準化された方法でフェデレーション動作を文書化する方法について, 2020年
• S. Bradner, RFCで要件レベルを示すためのキーワードの使用について, 1997年

著作権

CC0 1.0 Universal（CC0 1.0）パブリックドメイン献呈

法律で認められる範囲内において、本Fediverse Enhancement Proposalの著者らは、当該著作物に関するすべての著作権および関連する権利を放棄しています。