API REST et interface d'administration des observations de l'application Vigilo. Chaque association installe et gère sa propre instance ; les applications mobiles et la web app s'y connectent.
Un citoyen signale un problème (photo, position, catégorie, commentaire) ; les modérateurs de l'instance l'approuvent avant publication ; les services des villes (comptes citystaff) en suivent la résolution. Une instance peut couvrir plusieurs zones (scopes). Les photos sont pixelisées tant qu'elles ne sont pas approuvées et peuvent être floutées automatiquement (visages, plaques) par un serveur de floutage optionnel.
git clone https://github.com/jesuisundesdeux/vigilo-backend.git && cd vigilo-backend
cp .env_sample .env # mots de passe, VOLUME_PATH, BIND
docker compose up -d # --profile blur : serveur de floutage, --profile watchtower : mises à jour depuis l'adminPuis ouvrir https://<instance>/admin/ : l'assistant d'installation demande le code d'installation affiché par
docker compose logs web et crée le premier administrateur. En hébergement mutualisé, il configure aussi la base de données.
Procédures complètes (Docker, hébergement mutualisé, configuration) : documentation d'installation sur vigilo.city.
Images : vigilobs/vigilo-backend et
ghcr.io/jesuisundesdeux/vigilo-backend (PHP 8.3 ; le code reste compatible PHP 7.3).
| Document | Contenu |
|---|---|
| Fonctionnement | Cycle d'une observation, statuts, scopes, rôles, catégories, photos, pixelisation, floutage, webhooks |
| Installation (vigilo.city) | Docker ou hébergement mutualisé, initialisation |
| Configuration (vigilo.city) | Réglages de l'instance, scopes, villes, catégories, référencement |
| Administration (vigilo.city) | Panneau d'administration, rôles, modération |
| Sauvegarde (vigilo.city) | Données à sauvegarder |
| Webhooks | Exemples : Mastodon, Slack, Bluesky, ticketing de collectivité (Open311), Redmine |
| API REST | Vue d'ensemble des routes, paramètres et réponses |
| Mises à jour | Mise à jour depuis l'admin ou Docker (Watchtower), passage à la 0.0.22, anciennes versions (publiée aussi sur vigilo.city) |
| Architecture | Organisation du code, variables d'environnement, base de données |
| Guide du code | Fonctionnement détaillé du code : modules, routes, admin, données, sous-systèmes, tests, recettes, pièges |
| Guide du contributeur | Développement, tests, publication d'une version |
| Glossaire | Vocabulaire Vigilo |
| Serveur de floutage | Masquage des visages et plaques d'immatriculation |
| Tests | Lancer les suites de tests en local |
| Historique | Changements par version |
Documentation utilisateur de Vigilo : vigilo.city.
GPL-3.0 (COPYING). © Vélocité Montpellier et les contributeurs.