.. Wire documentation master file, created by
   sphinx-quickstart on Thu Jul 18 13:44:11 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Wire's documentation!
===============================================

If you are a Wire end-user, please check out our `support pages <https://support.wire.com/>`_.

The targeted audience of this documentation is:

* the curious power-user (people who want to understand how the server components of Wire work)
* on-premise operators/administrators (people who want to self-host Wire-Server on their own datacentres or cloud)
* developers (people who are working with the wire-server source code)

If you are a developer, you may want to check out the "Notes for developers" first.

This documentation may be expanded in the future to cover other aspects of Wire.

.. toctree::
   :maxdepth: 1
   :caption: Contents:
   :glob:

   Release notes <release-notes.rst>
   Administrator's Guide <how-to/index.rst>
   Understanding wire-server components <understand/index.rst>
   Administrator's manual: single-sign-on and user provisioning <understand/single-sign-on/main.rst>
   Client API documentation <understand/api-client-perspective/index.rst>
   Security responses <security-responses/index.rst>
   Notes for developers <developer/index.rst>

..   Overview <understand/overview>

.. commented out for now...

.. Indices and tables
.. ==================

.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`