summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source')
-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]