Notes for developers

If you are an on-premise operator (administrating your own self-hosted installation of wire-server), you may want to go back to docs.wire.com and ignore this section of the docs.

If you are a wire end-user, please check out our support pages.

What you need to know as a user of the Wire backend: concepts, features, and API. We want to keep these up to date. They could benefit from some re-ordering, and they are far from complete, but we hope they will still help you.

Contents:

• Developer
  • 1. API versioning
  • 2. How to build wire-server
  • 3. Writing code interacting with cassandra
  • 4. Changelog
  • 5. Dependencies
  • 6. Editor setup
  • 7. Features
  • 8. Federation API Conventions
  • 9. Developer how-to’s
  • 10. Linting
  • 11. PR Guidelines
  • 12. Internal processes
  • 13. Storing SCIM-related data
  • 14. Servant
  • 15. Testing the wire-server Haskell code base
  • 16. Upgrading
• Reference
  • 1. Config Options
  • 2. Creating and populating conversations
  • 3. Maintaining ElasticSearch
  • 4. ElasticSearch migration instructions for release 2021-02-16
  • 5. Make docker and QEMU
  • 6. OAuth
  • 7. SCIM tokens
  • 8. Spar braindump
  • 9. Legal hold
  • 10. User Activation
  • 11. Connection
  • 12. Connection backend internals
  • 13. User Registration
  • 14. User Rich info