GéoContrib est un outil libre de signalement contributif et collaboratif. Une version de démonstration est accessible sur https://geocontrib.demo.neogeo.fr/.

Depuis la version 2.0.0, l'interface web est dans une dépôt séparé : https://git.neogeo.fr/geocontrib/geocontrib-frontend

Documentation

L'intégralité de la documentation de GéoContrib est accessible ici : https://www.onegeosuite.fr/docs/module-geocontrib/intro Celle-ci n'est plus disponible dans le répertoire /docs du dépôt à partir de la version 5.4.1.

Version stable

La version stable de GéoContrib est une version qui a été testée et validée par la communauté GéoContrib. Nous recommandons l'installation de cette version dans le cas d'une utilisation optimale et sans instabilité.

La version actuellement stabilisée est la version 4.2.9.

Installation

Prérequis

• Python 3.7 (minimum 3.6)
• Instance de PostgreSQL/PostGIS avec une base de données dédiée à l'application (cf. paramètre DATABASES du fichier settings.py)

Création du projet Django et clone du repo

# installation dépendances
apt-get install -y libproj-dev gdal-bin ldap-utils libpq-dev libmagic1

# Création d'un environnement virtuel Python
python3 -m venv geocontrib_venv/

# Activation de cet environnement
source geocontrib_venv/bin/activate

# Clonage du projet - récupération des sources
# Actuellement, la branche par défaut du projet est develop
# Ce sera celle qui sera active par défaut immédiatement après le clonage
git clone https://github.com/neogeo-technologies/geocontrib.git
cd geocontrib

# Installer les dépendances
pip install -r requirements.txt

# Création d'un projet Django
django-admin startproject config .

Installation de l'interface Web en VueJS

L'interface Web intégrée à Django n'est plus maintenue depuis la 2.0, et sera retirée dans la 2.3

Il faut utiliser cette interface à la place: https://git.neogeo.fr/geocontrib/geocontrib-frontend

Édition des fichiers settings.py et url.py

Copier le contenu du fichier config_sample/settings.py dans config/settings.py.

Éditer les paramètres classiques de Django dans config/settings.py :

• SECRET_KEY https://docs.djangoproject.com/en/2.2/ref/settings/#secret-key
• DEBUG https://docs.djangoproject.com/en/2.2/ref/settings/#debug
• DATABASES https://docs.djangoproject.com/en/2.2/ref/settings/#databases
• TIME_ZONE https://docs.djangoproject.com/en/2.2/ref/settings/#std%3Asetting-TIME_ZONE
• STATIC_ROOT https://docs.djangoproject.com/en/2.2/ref/settings/#static-root
• MEDIA_ROOT https://docs.djangoproject.com/en/2.2/ref/settings/#media-root
• LOGGING https://docs.djangoproject.com/en/2.2/ref/settings/#logging
• EMAIL_HOST https://docs.djangoproject.com/en/2.2/ref/settings/#email-host
• EMAIL_PORT https://docs.djangoproject.com/en/2.2/ref/settings/#email-port
• EMAIL_USE_TLS https://docs.djangoproject.com/en/2.2/ref/settings/#email-use-tls
• EMAIL_HOST_USER https://docs.djangoproject.com/en/2.2/ref/settings/#std%3Asetting-EMAIL_HOST_USER
• EMAIL_HOST_PASSWORD https://docs.djangoproject.com/en/2.2/ref/settings/#email-host-password
• DEFAULT_FROM_EMAIL https://docs.djangoproject.com/en/2.2/ref/settings/#default-from-email
• DATA_UPLOAD_MAX_NUMBER_FIELDS https://docs.djangoproject.com/fr/2.2/ref/settings/#data-upload-max-number-fields
• LOGIN_URL https://docs.djangoproject.com/fr/3.1/ref/settings/#login-url

Éditer les paramètres spécifiques à l'outil dans config/settings.py :

• BASE_URL : URL du site, par exemple "https://geocontrib.deme.neogeo.fr" ;
• DEFAULT_SENDING_FREQUENCY : fréquence d'envoi des notifications par email (never/instantly/daily/weekly) ;
• APPLICATION_NAME : nom de l'application telle qu'elle apparaît dans l'IHM ;
• APPLICATION_ABSTRACT : description de l'application en langage naturel ;
• IMAGE_FORMAT : formats autorisés des fichiers téléversés dans l'application ;
• FILE_MAX_SIZE : taille maximale des fichiers téléversés dans l'application ;
• DEFAULT_BASE_MAP : configuration du fond de carte par défaut ;
• PROJECT_COPY_RELATED : configuration des modèles de projets ;
• MAGIC_IS_AVAILABLE (default: False) active la vérification des images téléversées ;
• LOGO_PATH : chemin vers le logo affiché en page d'accueil ;
• FAVICON_PATH : chemin vers la favicon affichée dans l'onglet du navigateur ;
• LOGOUT_HIDDEN : -> permet de cacher le bouton de déconnexion dans le backend Django (utile dans le cadre du SSO)
• HIDE_USER_CREATION_BUTTON : désactive le bouton d'ajout d'un utilisateur (utile dans le cadre du SSO)
• DISABLE_LOGIN_BUTTON : désactive le bouton de connexion (utile dans le cadre du SSO)
• LOG_URL : URL de connexion externe (utile dans le cadre du SSO)
• IDGO_URL = URL pour récupérer le catalogue DataSud ;
• MAPSERVER_URL = URL pour récupérer le geojson d'une ressource du catalogue ;
• IDGO_VERIFY_CERTIFICATE = permet de se connecter à datasud sans certificat, False en dév ;
• IDGO_LOGIN = login pour accéder au catalogue idgo depuis geocontrib ;
• IDGO_PASSWORD = mot de passe pour accéder au catalogue idgo depuis geocontrib ;

Copier le contenu du fichier config_sample/urls.py dans config/urls.py

Création des tables et ajout de données initiales dans la base de données

python manage.py migrate
python manage.py loaddata geocontrib/data/perm.json
python manage.py loaddata geocontrib/data/flatpages.json
python manage.py loaddata geocontrib/data/geocontrib_beat.json

Ne faites pas attention aux messages d'avertissement suivants :

Sites not migrated yet. Please make sure you have Sites setup on Django Admin

Dépot des images par défaut

Copier l'image par défaut et le logo de l'application dans le répertoire défini par le paramètre MEDIA_ROOT du fichier settings.py.

Par exemple, copier les images fournies dans les sources de l'application :

mkdir media
cp geocontrib/static/geocontrib/img/default.png media/
cp geocontrib/static/geocontrib/img/logo.png media/
cp geocontrib/static/geocontrib/img/logo-neogeo*.png media/

Création d'un superutilisateur

Lancer la commande Django de création d'un super utilisateur et suivre les instructions :

python manage.py createsuperuser

Paramétrage du domaine et du nom du site

Ces données sont à définir depuis l'admin Django dans la section Site et permettent notamment d'afficher les url dans les gabarit d'e-mail. Pour cela, lancer l'application Django :

python manage.py runserver

Se rendre dans l'interface d'administration Django et éditer le premier enregistrement des entités "Sites" (cf. yoururl.net/admin/sites/).

Configuration des tâches périodiques

Deux types de tâches requièrent d'invoquer une commande régulièrement (depuis celery-beat ou depuis un cron)

Tâches périodiques depuis celery

Copier le contenu du fichier config_sample/celery.py dans config/celery.py.

cp config_sample/celery.py config/celery.py

Pour une installation en local, si on a besoin de faire des imports de signalements par exemple, il faut ouvrir un nouveau terminal, activer l'environnement virtuel et lancer la commande suvante.

Lancer le worker celery:

celery -A config worker

Lancer le générateur d'évenements:

celery -A config beat

Dans /admin/django_celery_beat/periodictask, saisissez des tâches avec leur periodicité.

Tâches périodiques depuis un cron

L'envoi de mails de notifications, vous pouvez l'appeler toutes les minutes ou tous les jours selon vos préférences d'envoi

python manage.py notify_subscribers

L'archivage et la suppression des signalements, à invoquer une fois par jour

python manage.py data_cleansing

Déploiement dans un environnement geOrchestra

Reportez-vous au README.md présent dans le répertoire plugin_georchestra.

Sauvegarde des données

python manage.py dumpdata --natural-foreign --natural-primary -e contenttypes -e auth.Permission --indent 4 > dump.json

Génération du graphique du modèle

Après avoir installé graphiz et django-extensions

./manage.py graph_models --pygraphviz geocontrib --output docs/model.png

Le graphique est disponible ici docs/model.png

RUN TESTS

export DJANGO_SETTINGS_MODULE=config.settings pytest