.. 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 (self-hosting) documentation!
===============================================

The targeted audience of this documentation is (currently, as of July 2019):

* people wanting to understand how the server components of Wire work
* people wishing to self-host Wire on their own datacentres or cloud

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>
   Single-sign-on how-tos <how-to/single-sign-on/index.rst>
   Single-sign-on background (fragment) <understand/single-sign-on/design.rst>
   How to set up user provisioning with SCIM <how-to/scim/index.rst>
   Client API documentation <understand/api-client-perspective/index.rst>

..   Overview <understand/overview>

.. commented out for now...

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

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