Projet

Général

Profil

Support #5455

Update documentation

Ajouté par Benjamin Dauvergne il y a plus de 9 ans. Mis à jour il y a 5 mois.

Statut:
Fermé
Priorité:
Normal
Assigné à:
Gestion d'identité
Catégorie:
Documentation
Version cible:
Début:
03 décembre 2014
Echéance:
% réalisé:

100%

Temps estimé:
(Total: 0:00 h)
Patch proposed:
Non
Planning:
Non

Description

Documentation is currently out of date, a new toc should be made, obsolete sections should be removed or moved to externalised plugins and obsolete informations should be fixed.


Sous-tâches

Support #6047: Section fonctionnement des settingsFerméBenjamin Dauvergne

Actions
Support #6048: Complete the section settings listFerméBenjamin Dauvergne

Actions
Support #6049: Update references to settingsFerméBenjamin Dauvergne

Actions
Support #6050: Update upgrading sectionFerméBenjamin Dauvergne

Actions
Support #6051: Remove the FAQ style (rewrite section title written as question)Fermé

Actions
Support #6052: Rewrite attribute sectionFerméBenjamin Dauvergne

Actions
Support #6053: Write a quick start note for oauth2 idpFerméBenjamin Dauvergne

Actions
Support #6054: Write a quick start note for saml2 sp - google apps use caseFerméSerghei Mihai

Actions
Support #6055: Check the section on how policy worksFerméBenjamin Dauvergne

Actions
Support #6056: Add a section on user regsitration and emailingFerméBenjamin Dauvergne

Actions
Support #6057: Write a quick start note for saml2 idpFerméBenjamin Dauvergne

Actions

Révisions associées

Révision e5ebc662 (diff)
Ajouté par Mikaël Ates (de retour le 29 avril) il y a plus de 9 ans

documentation: refactor documentation (refs #5455).

Révision c3f8d5fe (diff)
Ajouté par Mikaël Ates (de retour le 29 avril) il y a plus de 9 ans

documentation: remove old documentation files (refs #5455)

Historique

#1

Mis à jour par Benjamin Dauvergne il y a plus de 9 ans

  • Assigné à changé de Benjamin Dauvergne à Thomas Noël
#2

Mis à jour par Benjamin Dauvergne il y a plus de 9 ans

Sections needing an update:
  • settings (they are not fully covered, we should try to use directly the app_settings.py files to generate that doc if possible, to keep it covered at all times)
  • LDAP as django-auth-ldap is not used anymore
  • attribute management for SAML (attribute aggregator being deprecated)
Missing sections:
  • basic user and group management using the new manager
  • definition of attributes
  • plugin system (how to make a plugin, what are the available hooks, idp interface and authentication frontend interface)
  • Kerberos authentication (it's an external plugin but maybe should-it be integrated)
  • OAuth2 IdP (idem)
  • settings around self-servicef of users: my account, registration page, federation management, a kind of end-user manual.

More than work on specific topics what's needed it a reorganization, first installation&configuration, then usual management then advanced topics.

I have an initial proposal:

  • Overview
    • Features
    • Source and issue tracker
    • Community support
  • Installation
    • Installing (lasso&pip|debian)
    • Creating and initializing the db
    • Creating admin users
    • Running with apache/nginx & serving static files
  • Configuration
    • Internal Django directory
      • Realms
      • Custom attributes
    • LDAP authentication
      • Realms
      • OpenLDAP case
      • AD case
      • Generic case (full description of the settings)
    • Kerberos authentication
    • CAS Authentication
    • Sessions&cookies
    • User self-service
      • Registration page
      • Password change
      • Profile page
    • SAML IdP settings
    • OAuth2 IdP settings
    • CAS IdP settings
    • OpenID IdP settings
    • Other settings
  • Day to day management
    • Managing users
    • Managing roles/groups
    • Managing SAML service provider
    • Managing OAuth2 service providers
    • Managing CAS service providers
    • Backup and restore
      • using fixtures
      • using pg_dump / psql
  • Advanced topics
    • Debugging
      • DEBUG=True
      • DEBUG_LOG
      • debug-toolbar
    • Writing plugins
      • IdP backend interface
      • Frontend interface
      • Authentication backends

We should not just document what exists, when existing is too difficult to document it should be changed. Separation between LibertyProvider, LibertyServiceProvider, SPOptionsIdPPolicy, LibertyProviderPolicy and AttributePolicy are artificial and should be removed. There should be only one object, SAMLServiceProvider that inherits from an abstract SAMLServiceProviderPolicyBase and can be linked to a concrete SAMLServiceProviderPolicy also.

#3

Mis à jour par Benjamin Dauvergne il y a plus de 9 ans

  • Assigné à changé de Thomas Noël à Gestion d'identité
#4

Mis à jour par Benjamin Dauvergne il y a environ 9 ans

  • Catégorie mis à Documentation
#5

Mis à jour par Benjamin Dauvergne il y a environ 9 ans

  • Version cible mis à future
#6

Mis à jour par Benjamin Dauvergne il y a plus de 8 ans

  • Version cible changé de future à 2.2.0
#8

Mis à jour par Benjamin Dauvergne il y a 5 mois

  • Statut changé de Nouveau à Fermé

Formats disponibles : Atom PDF