À propos de ce guide
À qui s'adresse ce guide, ce qu'il couvre et comment le lire.
Concerne :Équipe techniqueHébergeur
Ce guide décrit l'installation, la configuration, le déploiement, la sauvegarde, la sécurité et la surveillance de la plateforme READ sur un serveur. Il s'adresse à l'équipe technique (ICT) qui exploite la plateforme et à l'hébergeur.
L'utilisation fonctionnelle de la plateforme est décrite dans le Guide de l'utilisateur ; l'administration (comptes, paramètres, référentiels) dans le Guide de l'administrateur.
Ce que vous devez savoir avant de commencer#
Le guide suppose une pratique courante de :
- l'administration d'un serveur Linux (Ubuntu) en ligne de commande, par SSH ;
- Docker et Docker Compose ;
- les notions de nom de domaine, d'enregistrement DNS et de certificat HTTPS.
Aucune connaissance de .NET n'est nécessaire pour exploiter la plateforme : elle est livrée sous forme de conteneurs.
Organisation du guide#
| Chapitre | Contenu |
|---|---|
| Architecture | Composants, conteneurs, volumes, flux réseau |
| Prérequis | Serveur, nom de domaine, messagerie, stockage hors serveur |
| Installation | Préparation du serveur et premier déploiement |
| Configuration | Toutes les variables de réglage et leurs valeurs par défaut |
| Déploiement et mises à jour | Nouvelle version, retour arrière, migrations, mises à jour mensuelles |
| Sauvegarde et restauration | Sauvegarde quotidienne, copie chiffrée hors serveur, restauration |
| Sécurité | Mesures en place et responsabilités de l'exploitant |
| Supervision | Journaux, état de santé, place disque, alertes |
| Dépannage | Fiches d'incidents : symptôme, diagnostic, solution |
| API et module hors ligne | Jetons, durées, description OpenAPI, mise à jour du module |
| Environnement de démonstration | Données fictives et remise à zéro |
| Aide-mémoire | Les commandes utiles, regroupées |
Conventions#
- Les commandes sont à taper dans un terminal du serveur, sauf mention « depuis le poste » (le poste de l'équipe technique qui détient le code source).
- Les éléments à remplacer sont entre chevrons :
<alias-ssh>,<horodatage>. - Les exemples utilisent l'adresse fictive
read.example.org. - Les sorties de commande reproduites sont des exemples : les valeurs réelles diffèrent.
Important
Le fichier de réglages du serveur, /opt/read/.env, contient tous les secrets de la plateforme (mots de passe de la base, de l'administrateur initial, du serveur de messagerie, de la copie hors serveur). Il ne doit jamais être copié dans un ticket, un e-mail ou le dépôt de code.