.. Copyright (C) 2018 The Meme Factory, Inc.  http://www.karlpinc.com/


   This file is part of PGWUI_Logout.
  
   This program is free software: you can redistribute it and/or
   modify it under the terms of the GNU Affero General Public License
   as published by the Free Software Foundation, either version 3 of
   the License, or (at your option) any later version.

   This program is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Affero General Public License for more details.

   You should have received a copy of the GNU Affero General Public
   License along with this program.  If not, see
   <http://www.gnu.org/licenses/>.

   Karl O. Pinc <kop@karlpinc.com>

.. #End Of Copyright Marker#

PGWUI_Logout
============

Short Documentation
-------------------

PGWUI stands for `PostgreSQL`_ Web User Interface.

Logout page for the PGWUI Suite.

The PGWUI programs retain user credentials for some time and use them
to reconnect to the `PostgreSQL`_ server when necessary.  To end their
session early the user must logout.  The Logout page provides this
facility.

You will almost always want to install this when installing any of the
other PGWUI programs.


Usage
-----

PGWUI_Logout is included when PGWUI is installed.

When writing your own `Pyramid`_ application, in addition to
configuring ``pgwui_logout``, ``pgwui_common`` must typically be
configured.  This can be done with any of `Pyramid's <Pyramid_>`_
configuration mechanisms.


URL Configuration
-----------------

The default URL for PGWUI_Logout looks like
*https://www.example.com/logout*.

See the PGWUI_Common documentation for how to configure a different
URL.


Complete Documentation
----------------------

The complete documentation set can be found on the PGWUI_Logout home
page at http://pgwui_logout.readthedocs.io/.


License
-------

Except for files otherwise marked, distributed WITHOUT ANY WARRANTY
under the terms of the GNU Affero General Public License, version 3 or
a later version at your option.  See the copyright notices at the top
of each file and the LICENSE.txt file for details.


Acknowledgments
---------------

The PGWUI_Common code is based on the GMI_Pyramid sub-system created for
the `Gombe Mother Infant Database Project
<https://gombemi.ccas.gwu.edu>`_.  Support for extracting PGWUI_Core
from GMI_Pyramid, its Python packaging, and further enhancement was
provided by `The Dian Fossey Gorilla Fund
<https://www.gorillafund.org>`_.


.. _PostgreSQL: https://www.postgresql.org/
.. _Pyramid: https://trypyramid.com/