Vigilo

Installation sur serveur dédié avec Docker

Mon, 01 Jan 0001 00:00:00 +0000

Installation Vigilo sur serveur dédié avec Docker

Pré-requis

Logiciel

OS Linux
Docker avec Docker Compose (docker compose)
Un reverse proxy (Nginx, Caddy, Traefik…) qui gère le certificat HTTPS (Let’s Encrypt) et l’accès public à Vigilo : les applications refusent les instances en HTTP

Connaissances

Linux / Docker

Mise en place

Le code est dans l’image Docker : il suffit de deux fichiers, .env et docker-compose.yml, dans un répertoire du serveur (par exemple /opt/vigilo).

Modération

Mon, 01 Jan 0001 00:00:00 +0000

Ajout d’un modérateur

Actions modérateur

Via l’application web

Pour modérer, il faut une clé modérateur reconnue par l’instance de votre territoire. Dans l’application web https://app.vigilo.city, menu Devenir modérateur :

soit coller la clé fournie par l’administrateur de votre territoire, puis Enregistrer ;
soit Générer une clé, la copier et la transmettre à l’association : un administrateur l’ajoute dans le panneau d’administration (voir Actions administrateur). Enregistrer la clé dans l’application : le menu affiche « Clé modérateur en attente » jusqu’à ce qu’elle soit ajoutée.

La clé est propre à chaque territoire (une clé par territoire si vous modérez plusieurs territoires) et reste enregistrée sur l’appareil.

Sauvegarde

Mon, 01 Jan 0001 00:00:00 +0000

Données à sauvegarder

Il est important de sauvegarder quotidiennement les données Vigilo à un endroit différent que celui où est hebergé le site.

Les données Vigilo sont présentes sous forme de fichiers et d’une base de données.

Fichiers

Les repertoires suivants doivent être sauvegardés :

images/ : IMPORTANT ! contient les photos Vigilo
caches/ : moins important, contient les caches et les sauvegardes faites avant chaque mise à jour depuis l’administration
config/config.php (hébergement mutualisé) ou le fichier .env (Docker)

Base de données

Avec Docker

Ajouter en crontab :

Configuration Instance

Mon, 01 Jan 0001 00:00:00 +0000

Configuration de l’instance

Aller sur https://adresse_du_serveur/admin/, menu Configuration.

Instance

Nom de l’instance : par exemple « Vigilo Montpellier »
URL de base : adresse de Vigilo sans https:// (exemple : vigilo.jesuisundesdeux.org)
Protocole : https
Langue : fr-FR
Fuseau horaire : par exemple Europe/Paris
Jeu de caractères MySQL : utf8mb4 (à ne modifier qu’en connaissance de cause)

Publication

Afficher les observations non modérées : publier les observations sans attendre la validation d’un modérateur (leur photo reste pixelisée tant qu’elle n’est pas approuvée)
Masquer les observations résolues depuis plus de N jours : 0 pour ne jamais les masquer

Photos

Serveur de floutage : si renseigné, chaque photo envoyée est transmise à ce serveur qui masque visages et plaques d’immatriculation. Avec Docker, le service fourni s’active avec le profil blur (voir l’installation) ; laisser vide pour utiliser la variable VIGILO_BLUR_URL, ou pour publier les photos telles qu’envoyées. Si le serveur ne répond pas, la photo est conservée telle quelle : la modération reste le garde-fou.

Anti-spam

Observations créées max. par IP et par 10 minutes : au-delà, les créations depuis la même adresse sont refusées temporairement (60 par défaut, 0 = pas de limite)

Installation sur hebergement PHP/MySQL

Mon, 01 Jan 0001 00:00:00 +0000

Installation sur serveur mutualisé

Pré-requis

Logiciel

PHP 7.3 à 8.3 avec les extensions mysqli, gd, curl et fileinfo (zip et sodium pour les mises à jour depuis l’administration)
Une base de données MySQL ou MariaDB
Un certificat HTTPS (les applications refusent les instances en HTTP)

Connaissances

PHP / MySQL, transfert de fichiers (FTP/SFTP), phpMyAdmin

Mise en place

Téléchargement

Télécharger l’archive Source code de la dernière version sur https://github.com/jesuisundesdeux/vigilo-backend/releases et copier le contenu du répertoire app/ à la racine du site.

Initialisation

Mon, 01 Jan 0001 00:00:00 +0000

Assistant d’installation

Au premier accès à https://adresse_du_serveur/admin/, l’assistant d’installation (admin/setup.php, backend 0.0.31 et plus récent) prend la main tant que l’instance n’est pas installée.

Code d’installation : il prouve que vous administrez le serveur ; sans lui, rien ne peut être modifié.
- Hébergement mutualisé : fichier caches/setup-code.php du serveur (FTP, gestionnaire de fichiers) ;
- Docker : affiché au démarrage du conteneur (docker compose logs web | grep -i "code d'installation"), ou docker compose exec web cat caches/setup-code.php.
Base de données : hébergement mutualisé, formulaire d’accès à la base avec un bouton Tester la connexion (connexion et droits de création des tables), puis écriture de config/config.php ; Docker, vérification de la connexion avec les variables MYSQL_* du fichier .env.
Initialisation de la base : création des tables (scripts de migrations/), ou mise à jour d’une base plus ancienne. L’assistant compare la version de la base à celle du code et refuse une base plus récente que le code. Avec Docker, la base est déjà initialisée au démarrage du conteneur.
Compte administrateur : login et mot de passe (10 caractères au moins), nom de l’instance, et URL de base et protocole, détectés d’après l’adresse utilisée dans le navigateur (à corriger si l’instance est publiée à une autre adresse).

Le compte créé, l’assistant ouvre l’administration et se ferme définitivement (le code d’installation est supprimé).

Ajout scope

Mon, 01 Jan 0001 00:00:00 +0000

Configuration Scope

Les scopes sont des zones géographiques indépendantes au sein d’une même instance. Ils correspondent en règle générale à une métropole, une agglomération voire une ville ; un seul scope suffit le plus souvent.

Dans le panneau d’administration, menu Scopes, le bouton Ajouter un scope ouvre une fenêtre qui demande l’identifiant, le nom affiché, le département et l’email de contact, puis Créer le scope. Chaque scope s’affiche ensuite dans un cadre où compléter ses informations, tracer son territoire sur la carte et Enregistrer :

Ajout villes

Mon, 01 Jan 0001 00:00:00 +0000

Configuration Villes

Dans le panneau d’administration, menu Villes, ajouter l’ensemble des villes du territoire : en les important (ci-dessous), ou une à une avec le bouton Ajouter une ville, qui ouvre une fenêtre (nom, scope, code postal, surface, population, site). Cela permet de filtrer les observations par ville et de limiter les comptes des services municipaux (citystaff) aux observations de leurs villes.

Importer les communes du territoire

En haut de la page Villes, Importer les communes d’un territoire (ou le bouton Importer les villes du territoire d’un scope) :

Catégories

Mon, 01 Jan 0001 00:00:00 +0000

Configuration Catégories

Les catégories classent les observations (stationnement sur piste cyclable, trottoir encombré…). La liste nationale (vigilo-conf) est commune à toutes les instances ; chaque instance peut l’adapter depuis le panneau d’administration, menu Catégories (back-end 0.0.23 ou plus récent).

L’application web lit la liste de l’instance. Les applications qui ne la lisent pas encore continuent d’utiliser la liste nationale.

Catégories nationales

Le tableau affiche chaque catégorie nationale, son nombre d’observations et son état :