summaryrefslogtreecommitdiff
path: root/docs/index.rst
diff options
context:
space:
mode:
authorEli Collins <elic@assurancetechnologies.com>2011-03-22 14:48:55 -0400
committerEli Collins <elic@assurancetechnologies.com>2011-03-22 14:48:55 -0400
commit954793fe3bf7f2878598b9429c39f7d654a1327b (patch)
treed5832bc356bd7ce69293161b00cc058c94b82bfe /docs/index.rst
parentf6c3fb3c0878cc74a4467828418ffb3ccd0082b2 (diff)
downloadpasslib-954793fe3bf7f2878598b9429c39f7d654a1327b.tar.gz
documentation work & rearranging
================================ * added documentation for overview, ldap digests * lots of other documentation updates * renamed passlib.unix -> passlib.hosts * renamed passlib.sqldb -> passlib.servers * added passlib.servers.custom_app_context for quickstart purposes * added ldap {CLEARTEXT} support
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst48
1 files changed, 14 insertions, 34 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 3a78d56..45efdf1 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -4,45 +4,25 @@ PassLib |release| documentation
Introduction
============
-PassLib is a library for managing password hashes,
-with support for over 18 current and historical :doc:`password hash schemes <lib/passlib.hash>`.
+PassLib is a library for encrypting, verifying, and managing password hashes.
+It supports over 20 current and historical password hash schemes.
It can be used for a variety of purposes:
- * cross-platform replacement for stdlib's ``crypt()``.
- * encrypting & verifying most known hash formats used by:
- - Linux & BSD shadow files
- - Apache htpasswd files
- - MySQL & PostgreSQL user account tables
- * drop-in password hashing for new python applications.
- * building a configurable hashing policy
- for python applications to migrate existing hashing schemes.
-
-See the :doc:`Library Overview <overview>` for more details.
+* cross-platform replacement for stdlib's ``crypt()``.
+* encrypting & verifying most known hash formats used by:
+ - Linux & BSD shadow files
+ - Apache htpasswd & htdigest files
+ - MySQL, PostgreSQL, Oracle user account tables
+ - LDAP
+* drop-in password hashing for new python applications.
+* building a configurable hashing policy
+ for python applications to migrate existing hashing schemes.
Quick Links
===========
-.. raw:: html
-
- <table class="contentstable" align="center">
- <tr>
- <td width="50%" valign="top">
- <p class="biglink"><a class="biglink" href="contents.html">Table of Contents</a><br>
- <span class="linkdescr">lists all sections and subsections</span></p>
-
- <p class="biglink"><a class="biglink" href="overview.html">Library Overview</a><br>
- <span class="linkdescr">describes how PassLib is laid out</span></p>
-
- </td><td width="50%">
-
- <p class="biglink"><a class="biglink" href="genindex.html">General Index</a><br>
- <span class="linkdescr">all functions, classes, terms</span></p>
-
- <p class="biglink"><a class="biglink" href="py-modindex.html">Module List</a><br>
- <span class="linkdescr">quick access to all modules</span></p>
+* See the :doc:`Library Overview <overview>` for more details about passlib.
- <p class="biglink"><a class="biglink" href="search.html">Search Page</a><br>
- <span class="linkdescr">search this documentation</span></p>
+* See the :doc:`Installation Instructions <install>` to get PassLib installed on your system.
- </td></tr>
- </table>
+* See the :mod:`passlib.hash <passlib.hash>` module for a complete list of supported hash algorithms.