summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSteve Martinelli <stevemar@ca.ibm.com>2016-01-31 00:48:01 -0500
committerSteve Martinelli <s.martinelli@gmail.com>2016-06-28 23:56:47 +0000
commitef29dfce898af273fef7b4798920cc981644de62 (patch)
treef433d5210bf10168a4accff1d1c75cfc87445712 /doc
parent2a1b9b7dc7a04052e6d47f394c7526b83939d8b2 (diff)
downloadkeystonemiddleware-ef29dfce898af273fef7b4798920cc981644de62.tar.gz
Use extras for oslo.messaging dependency
Install the oslo.messaging optional dependency by doing: keystonemiddleware[audit_notifications] pbr documentation: http://docs.openstack.org/developer/pbr/#environment-markers Partial-Bug: 1540115 Change-Id: I59eea1f7eb0e770ac4fe30211eff49ae76fb2550
Diffstat (limited to 'doc')
-rw-r--r--doc/source/index.rst1
-rw-r--r--doc/source/installation.rst25
2 files changed, 26 insertions, 0 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 666a842..b784d02 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -13,6 +13,7 @@ Contents:
middlewarearchitecture
audit
+ installation
Related Identity Projects
=========================
diff --git a/doc/source/installation.rst b/doc/source/installation.rst
new file mode 100644
index 0000000..4a9b3f6
--- /dev/null
+++ b/doc/source/installation.rst
@@ -0,0 +1,25 @@
+==============
+ Installation
+==============
+
+Install using pip
+-----------------
+
+At the command line::
+
+ $ pip install keystonemiddleware
+
+Or, if you want to use it in a virtualenvwrapper::
+
+ $ mkvirtualenv keystonemiddleware
+ $ pip install keystonemiddleware
+
+Install optional dependencies
+-----------------------------
+
+Certain keystonemiddleware features are only available if specific libraries
+are available. These libraries can be installed using pip as well.
+
+To install support for audit notifications::
+
+ $ pip install keystonemiddleware[audit_notifications]