Wire federation

Wire Federation, once implemented, aims to allow multiple Wire-server backends to federate with each other. That means that a user 1 registered on backend A and a user 2 registered on backend B should be able to interact with each other as if they belonged to the same backend.

Note

Federation is as of July 2021 still early work in progress, since the implementation of federation is ongoing, and certain design decision are still subject to change. Where possible documentation will indicate the state of implementation.

Some sections of the documentation are still incomplete (indicated with a ‘TODO’ comment). Check back later for updates.

• 1. Introduction
  • 1.1. Goals
  • 1.2. Non-Goals
• 2. Architecture and Network
  • 2.1. Architecture
  • 2.2. Backend to backend communication
• 3. Implementation Roadmap
  • 3.1. M1 federation with proteus MVP
  • 3.2. M(N) | N >1
• 4. API
  • 4.1. Qualified Identifiers and Names
  • 4.2. API between Federators
  • 4.3. API From Components to Federator
  • 4.4. API From Federator to Components
  • 4.5. List of Federation APIs exposed by Components
  • 4.6. End-to-End Flows
• 5. Error Codes
  • 5.1. Authentication Errors
• 6. Federation FAQ
• 7. Federation Glossary