summaryrefslogtreecommitdiffstats
path: root/doc/index.rst
blob: a283ec070bbdba6242a92501f80ebefb05bd59b0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
.. Authentic 2 documentation master file, created by
   sphinx-quickstart on Thu Oct 13 09:53:03 2011.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

===========================
Authentic 2's documentation
===========================

Authentic 2 is a versatile identity provider addressing a broad
range of needs, from simple to advanced setups, around web authentication,
attribute sharing and namespace mapping.

Authentic 2 supports many protocols and standards, including SAML2, CAS, OpenID,
LDAP, X509, OATH, and can bridge between them.

Authentic 2 is under the GNU AGPL version 3 licence.

It has support for SAMLv2 thanks to `Lasso <http://lasso.entrouvert.org>`_,
a free (GNU GPL) implementation of the Liberty Alliance and OASIS
specifications of SAML2, ID-FF1.2 and ID-WSF2.

The Documentation is under the licence Creative Commons `CC BY-SA 2.0 <http://creativecommons.org/licenses/by-sa/2.0/>`_.

- `Authentic 2 project site <http://dev.entrouvert.org/projects/authentic>`_
- `Authentic 2 roadmap <http://dev.entrouvert.org/projects/authentic/roadmap>`_

Documentation content
=====================

.. toctree::
   :maxdepth: 2

   features

   download

   installation

   settings

   auth_ldap

   auth_pam

   administration_with_policies

   where_metadata

   config_saml2_sp

   config_saml2_idp

   saml2_slo

   sync-metadata_script

   config_cas_sp

   attribute_management

   attribute_management_explained

   attributes_in_session

   consent_management

Copyright
=========

Authentic and Authentic 2 are copyrighted by Entr'ouvert and are licensed
through the GNU AFFERO GENERAL PUBLIC LICENSE, version 3 or later. A copy of
the whole license text is available in the COPYING file.

The OpenID IdP originates in the project django_openid_provider by Roman
Barczyski, which is under the Apache 2.0 licence. This imply that you must
distribute authentic2 under the AGPL3 licence when distributing this part of the
project which is the only AGPL licence version compatible with the Apache 2.0
licence.

The Documentation is under the licence Creative Commons
`CC BY-SA 2.0 <http://creativecommons.org/licenses/by-sa/2.0/>`_.

.. Indices and tables
.. ==================

.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`