Projet

Général

Profil

0001-doc-add-a-reference-to-the-release-cycle-51668.patch

Loïc Dachary, 04 mars 2021 14:29

Télécharger (6,62 ko)

Voir les différences: 

Subject: [PATCH] doc: add a reference to the release cycle (#51668)

* add a link to the release cycle in the installation section
* update python and django versions
* remove obsolete instructions
* move the issue tracker to the section in which it belongs
* fix a typo

Fixes: #51668

License: MIT

 doc/installation.rst       |  9 +++-
 doc/installation_modes.rst | 85 +++++---------------------------------
 doc/overview.rst           | 10 ++---
 3 files changed, 23 insertions(+), 81 deletions(-)
doc/installation.rst
5 5 
=====================================
6 6 

  		




  7
  7
  
    
You'll find here how to start and configure very quickly Authentic 2 for its

  		




  8
  
  
    
main features. You just need Python 2.7 and Django 1.5.

  		




  
  8
  
    
main features. You just need Python 3 and Django 2.2.

  		




  9
  9
  
    

  		




  10
  
  
    
First of all, you can boot Authentic vwithout root

  		




  
  10
  
    
First of all, you can boot Authentic without root

  		




  11
  11
  
    
privileges  like this:

  		




  12
  12
  
    

  		




  13
  13
  
    
1. Initialize a virtualenv::

  		




  ......




  28
  28
  
    

  		




  29
  29
  
    
    authentic2-ctl runserver

  		




  30
  30
  
    

  		




  
  31
  
    
Release cycle

  		




  
  32
  
    
-------------

  		




  
  33
  
    

  		




  
  34
  
    
The release cycle of Authentic follows the `release cycle of Publik <https://dev.entrouvert.org/projects/publik/wiki/Cycle_de_mises_%C3%A0_jour>`__.

  		




  
  35
  
    

  		




  31
  36
  
    
Quickstart guides and installation guidelines

  		




  32
  37
  
    
---------------------------------------------

  		




  33
  38
  
    

  		












  

    
      doc/installation_modes.rst
    
  





  4
  4
  
    
Installation modes

  		




  5
  5
  
    
==================

  		




  6
  6
  
    

  		




  7
  
  
    
The current version of Authentic 2 works with Python 2.7 and Django 1.5.

  		




  
  7
  
    
The current version of Authentic 2 works with Python 3 and Django 1.11 or 2.2.

  		




  8
  8
  
    

  		




  9
  9
  
    
Authentic 2 python installation script handles all the dependencies,

  		




  10
  10
  
    
except Lasso, relying on the Setuptools and the pypi repository.

  		




  ......




  12
  12
  
    
To run Authentic 2 with SAML2 features, you need to install lasso >= 2.3.6,

  		




  13
  13
  
    
see :ref:`install-lasso-ref`.

  		




  14
  14
  
    

  		




  15
  
  
    
The other Authentic 2 dependencies are:

  		




  16
  
  
    

  		




  17
  
  
    
- Django>=1.7.6,<1.9

  		




  18
  
  
    
- requests>=2.

  		




  19
  
  
    
- django-model-utils>=2

  		




  20
  
  
    
- dnspython>=1.12

  		




  21
  
  
    
- django-select2>=4.3.0

  		




  22
  
  
    
- django-tables2>=1.0

  		




  23
  
  
    
- gadjo>=0.6

  		




  24
  
  
    
- django-import-export>=0.2.7,<=0.4.5

  		




  25
  
  
    
- djangorestframework>=3.3

  		




  26
  
  
    
- six>=1.9

  		




  27
  
  
    
- Markdown>=2.5

  		




  28
  
  
    
- python-ldap

  		




  29
  
  
    

  		




  30
  15
  
    
Install Authentic 2:

  		




  31
  16
  
    

  		




  32
  17
  
    
- :ref:`install-pypi-ref`

  		




  ......




  50
  35
  
    
You can also install lasso from sources  http://lasso.entrouvert.org/download

  		




  51
  36
  
    

  		




  52
  37
  
    
See the `Lasso website <http://lasso.entrouvert.org>`_ for installation details.

  		




  53
  
  
    
This is a quick installation example.

  		




  54
  
  
    

  		




  55
  
  
    
Install the following Lasso dependencies:

  		




  56
  
  
    

  		




  57
  
  
    
- autoconf

  		




  58
  
  
    
- automake

  		




  59
  
  
    
- autotools-dev

  		




  60
  
  
    
- libtool

  		




  61
  
  
    
- gtk-doc-tools

  		




  62
  
  
    
- zlib1g-dev

  		




  63
  
  
    
- libglib2.0-dev

  		




  64
  
  
    
- openssl-dev

  		




  65
  
  
    
- libxml2-dev

  		




  66
  
  
    
- libxmlsec1-dev

  		




  67
  
  
    
- python2.6-dev

  		




  68
  
  
    
- python-setuptools

  		




  69
  
  
    

  		




  70
  
  
    
Obtain Lasso::

  		




  71
  
  
    

  		




  72
  
  
    
  $wget https://dev.entrouvert.org/lasso/lasso-2.3.6.tar.gz

  		




  73
  
  
    
  $tar xzvf lasso-2.3.6.tar.gz

  		




  74
  
  
    
  $cd lasso-2.3.6

  		




  75
  
  
    
  $./autogen.sh

  		




  76
  
  
    

  		




  77
  
  
    
Be sure that the Python bindings is selected as follows::

  		




  78
  
  
    

  		




  79
  
  
    
    =============

  		




  80
  
  
    
    Configuration

  		




  81
  
  
    
    =============

  		




  82
  
  
    

  		




  83
  
  
    
    Main

  		




  84
  
  
    
    ----

  		




  85
  
  
    

  		




  86
  
  
    
    Compiler:                gcc

  		




  87
  
  
    
    CFLAGS:

  		




  88
  
  
    
    Install prefix:          /usr/local

  		




  89
  
  
    
    Debugging:               no

  		




  90
  
  
    
    Experimental ID-WSF:     no

  		




  
  38
  
    
This is a quick installation example. Obtain Lasso::

  		




  91
  39
  
    

  		




  92
  
  
    
    Optionals builds

  		




  93
  
  
    
    ----------------

  		




  94
  
  
    

  		




  95
  
  
    
    Available languages:    java(4.6.1) python(2.7) perl(5.12.4)

  		




  96
  
  
    

  		




  97
  
  
    
    Java binding:           yes

  		




  98
  
  
    
    Perl binding:           yes

  		




  99
  
  
    
    PHP 5 binding:          no

  		




  100
  
  
    
    Python binding:         yes

  		




  101
  
  
    

  		




  102
  
  
    
    C API references:       yes

  		




  103
  
  
    
    Tests suite:            no

  		




  104
  
  
    

  		




  105
  
  
    

  		




  106
  
  
    
    Now type 'make install' to install lasso.

  		




  
  40
  
    
  $wget https://dev.entrouvert.org/lasso/lasso-2.6.1.tar.gz

  		




  
  41
  
    
  $tar xzvf lasso-2.6.1.tar.gz

  		




  
  42
  
    
  $cd lasso-2.6.1

  		




  
  43
  
    
  $./autogen.sh

  		




  107
  44
  
    

  		




  108
  
  
    
As indicated, build and install::

  		




  
  45
  
    
Build and install::

  		




  109
  46
  
    

  		




  110
  47
  
    
  $make install

  		




  111
  48
  
    
  $ldconfig

  		




  112
  49
  
    

  		




  113
  50
  
    
Set the lasso python binding in you python path, e.g.::

  		




  114
  51
  
    

  		




  115
  
  
    
  $export PYTHONPATH="$PYTHONPATH:/usr/local/lib/python2.6/site-packages"

  		




  
  52
  
    
  $export PYTHONPATH="$PYTHONPATH:/usr/local/lib/python3.8/site-packages"

  		




  116
  53
  
    

  		




  117
  54
  
    
Test trying to import Lasso::

  		




  118
  55
  
    

  		




  ......




  138
  75
  
    
  Validating models...

  		




  139
  76
  
    
  0 errors found

  		




  140
  77
  
    

  		




  141
  
  
    
  Django version 1.5, using settings 'authentic.settings'

  		




  
  78
  
    
  Django version 2.2, using settings 'authentic.settings'

  		




  142
  79
  
    
  Development server is running at http://127.0.0.1:8000/

  		




  143
  80
  
    
  Quit the server with CONTROL-C.

  		




  144
  81
  
    

  		




  ......




  165
  102
  
    
  Validating models...

  		




  166
  103
  
    
  0 errors found

  		




  167
  104
  
    

  		




  168
  
  
    
  Django version 1.5, using settings 'authentic.settings'

  		




  
  105
  
    
  Django version 2.2, using settings 'authentic.settings'

  		




  169
  106
  
    
  Development server is running at http://127.0.0.1:8000/

  		




  170
  107
  
    
  Quit the server with CONTROL-C.

  		




  171
  108
  
    

  		




  ......




  195
  132
  
    
  Validating models...

  		




  196
  133
  
    
  0 errors found

  		




  197
  134
  
    

  		




  198
  
  
    
  Django version 1.5, using settings 'authentic.settings'

  		




  
  135
  
    
  Django version 2.2, using settings 'authentic.settings'

  		




  199
  136
  
    
  Development server is running at http://127.0.0.1:8000/

  		




  200
  137
  
    
  Quit the server with CONTROL-C.

  		




  201
  138
  
    

  		












  

    
      doc/overview.rst
    
  





  17
  17
  
    
a free (GNU GPL) implementation of the Liberty Alliance and OASIS

  		




  18
  18
  
    
specifications of SAML2.

  		




  19
  19
  
    

  		




  20
  
  
    
Authentic 2 requires Python 2.7 et Django 1.5.

  		




  
  20
  
    
Authentic 2 is tested with Python 3, Django 1.11 and Django 2.2, DRF 3.4 and DRF 3.9

  		




  21
  21
  
    

  		




  22
  22
  
    
Features

  		




  23
  23
  
    
--------

  		




  ......




  48
  48
  
    

  		




  49
  49
  
    
    git clone http://repos.entrouvert.org/authentic.git

  		




  50
  50
  
    

  		




  
  51
  
    
You can open reports or feature request on https://dev.entrouvert.org/projects/authentic/issues.

  		




  
  52
  
    

  		




  51
  53
  
    
Support

  		




  52
  54
  
    
-------

  		




  53
  55
  
    
Authentic's developpers and users hangs on the mailing list authentic@listes.entrouvert.com.

  		




  54
  
  
    
See archives or register at http://listes.entrouvert.com/info/authentic.

  		




  55
  
  
    

  		




  56
  
  
    
You can open reports or feature request on http://authentic.entrouvert.org.

  		




  
  56
  
    
See archives or register at https://listes.entrouvert.com/info/authentic.

  		




  57
  57
  
    

  		




  58
  
  
    
Entr'ouvert also provides a commercial support. For information, visit http://www.entrouvert.com.

  		




  
  58
  
    
Entr'ouvert also provides a commercial support. For information, visit https://www.entrouvert.com.

  		




  59
  
  
    
-