keystone/doc/source/index.rst
Alvaro Lopez Garcia 8c15e3eba6 Added documentation for the external auth support
This covers given authentication using REMOTE_USER and also the way to
implement custom auth with WSGI middleware.

DocImpact
blueprint: pluggable-identity-authentication-handlers
Change-Id: Idbac8c38d1f0be1febbbc8056c929bada6bbb07e
2012-12-03 11:27:37 +01:00

85 lines
2.2 KiB
ReStructuredText

..
Copyright 2011-2012 OpenStack, LLC
All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
====================================================
Welcome to Keystone, the OpenStack Identity Service!
====================================================
Keystone is an OpenStack project that provides Identity, Token, Catalog and
Policy services for use specifically by projects in the OpenStack family.
It implements `OpenStack's Identity API`_.
This document describes Keystone for contributors of the project, and assumes
that you are already familiar with Keystone from an `end-user perspective`_.
.. _`OpenStack's Identity API`: http://docs.openstack.org/api/openstack-identity-service/2.0/content/
.. _`end-user perspective`: http://docs.openstack.org/
This documentation is generated by the Sphinx toolkit and lives in the source
tree. Additional documentation on Keystone and other components of OpenStack
can be found on the `OpenStack wiki`_. Also see the :doc:`community` page for
other ways to interact with the community.
.. _`OpenStack wiki`: http://wiki.openstack.org
Getting Started
===============
.. toctree::
:maxdepth: 1
setup
installing
configuration
configuringservices
community
Man Pages
=========
.. toctree::
:maxdepth: 1
man/keystone-all
man/keystone-manage
Developers Documentation
========================
.. toctree::
:maxdepth: 1
developing
architecture
middlewarearchitecture
api_curl_examples
apache-httpd
external-auth
Code Documentation
==================
.. toctree::
:maxdepth: 1
api/autoindex
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`