Portail Citoyen
This repository has been archived on 2023-02-21. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
Benjamin Dauvergne 5a765e9b23 Prevent the logout view to put message (behaviour inherited from django-allauth)
fixes #5734
2014-12-19 11:06:01 +01:00
help/fr help: spelling fix 2013-10-31 10:08:07 +01:00
portail_citoyen2 Prevent the logout view to put message (behaviour inherited from django-allauth) 2014-12-19 11:06:01 +01:00
tools fixtures: merge init and authentic2 and update it 2014-01-23 16:56:09 +01:00
.gitignore update gitignore 2014-03-04 22:50:39 +01:00
COPYING add copy of AGPL text 2014-10-21 10:27:29 +02:00
MANIFEST.in MANIFEST.in: add *.otf to exported extensions 2014-04-03 10:06:23 +02:00
README README: complete document to use authentic2 as an OAuth2 IdP 2014-05-26 23:17:01 +02:00
TODO first commit of portail-citoyen2 2014-02-28 16:08:41 +01:00
jenkins.sh jenkins.sh: test the start.sh script 2014-05-26 23:16:49 +02:00
load-base-data.sh improve developer start scripts 2014-01-21 17:08:18 +01:00
local_settings.py.example enable portail citoyen to be standalone 2014-01-16 13:35:24 +01:00
portail-citoyen2 remove all code linked to authentic2, add dependency on djangocms-text-ckeditor 2014-03-04 18:10:00 +01:00
requirements.txt useless dependencies removed. 2014-09-04 16:42:50 +02:00
run.sh remove all code linked to authentic2, add dependency on djangocms-text-ckeditor 2014-03-04 18:10:00 +01:00
setup.py Remove dependency link toward python-entrouvert 2014-09-17 10:23:00 +02:00
start.sh start.sh: make it work inside jenkins 2014-05-26 23:40:04 +02:00

README

How to start
============

To work on portail-citoyen2 just execute the following lines (command
to launch start with $, other lines are expected output)::

  $ ./start.sh

The application is now usable at http://localhost:8000/

On subsequent runs, do:

  $ ./run.sh

Using with authentic2 as a source of social accounts
----------------------------------------------------

Install authentic2 and authentic2-idp-oauth2, then set the AUTHENTIC2_URL
environment variable to the URL of the homepage of authentic2.

On Authentic2 you must create an A2Client object on
http://authentic/admin/authentic2_idp_oauth2/a2client/add/ with the following settings:

  URL: http://localhost:8000/
  Redirect URL: http://localhost:8000/accounts/authentic2/login/callback/
  Client type: confidential

authentic2 will generate a client id and a client secret for you.

On portail-citoyen2 you must create a SocialApp object using the client id and
client secret your generated in authentic2 on:

  http://localhost:8000/admin/socialaccount/socialapp/add/


Settings
--------

Settings can be passed using a local_settings.py file or the shell
environment. Dictionaries are passed by flattening the variable name and the
dictionnary key separated by an underscore character. For example to passe the
variable MAIN_SITE_URL in templates, define the following environment
variable::

    export PORTAIL_CITOYEN_TEMPLATE_VARS_MAIN_SITE_URL=https://main-site.com/

Those variables must be prefixed with PORTAIL_CITOYEN_ when set in a
local_settings.py file or in the environment.

Name                             Description
================================ ============================================
TEMPLATE_VARS                    dictionnary of variables passed to templates
PORTAIL_ADMIN_URL                URL of the global administration portal