ScoDoc/DocScoDoc
7
2
Fork 10
Code Issues 1 Pull Requests 1 Projects Releases Wiki Activity

Liens vers install Debian 12

Browse Source
This commit is contained in:
Emmanuel Viennet 2024-05-30 15:26:44 +02:00
parent f9caeb90f3
commit c687db297c
11 changed files with 52 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/ConfigEmail.md
View File

@ -35,8 +35,8 @@ réglées via via la page **Paramétrage** de chaque département:
![Réglage des notifications](fig/config-dept-abs.png) ![Réglage des notifications](fig/config-dept-abs.png)
!!! note "Voir aussi" !!! note "Voir aussi"
- Configuration système: [Envoi des courriers électroniques](ProblemesMail.md) - Configuration système: [Envoi des courriers électroniques](ProblemesMail.md)
- Installation, flux réseaux et configuration: [Guide d'installation](GuideInstallDebian11.md) - Installation, flux réseaux et configuration: [Guide d'installation](GuideInstallDebian12.md)
- [Contacts](Contact.md) - [Contacts](Contact.md)

10
docs/ConseilServeurDev.md
View File

@ -13,8 +13,8 @@ aussi bien l'affaire).
### Conseils pour la machine virtuelle ### Conseils pour la machine virtuelle
[VirtualBox](https://www.virtualbox.org/) est facile à installer sur Linux ou [VirtualBox](https://www.virtualbox.org/) est facile à installer sur Linux ou
Windows. Créer une VM avec Debian 10, et suivre la Windows. Créer une VM avec Debian 12, et suivre la
[procédure habituelle d'installation de ScoDoc](GuideInstallDebian11.md). [procédure habituelle d'installation de ScoDoc](GuideInstallDebian12.md).
Sur les Macs anciens (processeurs Intel), VirtualBox fonctionne bien. Sur les Sur les Macs anciens (processeurs Intel), VirtualBox fonctionne bien. Sur les
modèles "M1" (Apple Silicon), je conseille d'utiliser modèles "M1" (Apple Silicon), je conseille d'utiliser
@ -70,7 +70,7 @@ la VM:
ici `enp0s8` correspond à l'`Adapter 2`. Si vous travaillez sur une machine fixe ici `enp0s8` correspond à l'`Adapter 2`. Si vous travaillez sur une machine fixe
avec connexion permanente, vous pouvez dans Debian activer cette interface avec connexion permanente, vous pouvez dans Debian activer cette interface
constamment (modifier `/etc/network/interfaces`). constamment (modifier `/etc/network/interfaces`).
### Noms des machines ### Noms des machines
@ -91,9 +91,9 @@ type `sshfs`peut aussi faire l'affaire).
- [Conventions de codage](DevConventions.md) - [Conventions de codage](DevConventions.md)
- [API ScoDoc 9](ScoDoc9API.md) - [API ScoDoc 9](ScoDoc9API.md)
- [Guide installation](GuideInstallDebian11.md) - [Guide installation](GuideInstallDebian12.md)
- [Gestion des utilisateurs](AdminUsers.md) - [Gestion des utilisateurs](AdminUsers.md)
- [Guide administrateur ScoDoc](GuideAdminSys.md) - [Guide administrateur ScoDoc](GuideAdminSys.md)
- [FAQ](FAQ.md) - [FAQ](FAQ.md)
- [Contacts](Contact.md) - [Contacts](Contact.md)
- -

2
docs/FAQ.md
View File

@ -135,7 +135,7 @@ Voir [la page sur la gestion des logos et images](GestionLogos.md).
ScoDoc est accessible depuis n'importe quel navigateur Web (Firefox, Chrome, ...). ScoDoc est accessible depuis n'importe quel navigateur Web (Firefox, Chrome, ...).
Le serveur ScoDoc fonctionne sous Linux. Il n'est testé qu'avec Debian (stable). Le serveur ScoDoc fonctionne sous Linux. Il n'est testé qu'avec Debian (stable).
Le script d'installation ([GuideInstallDebian11](GuideInstallDebian11.md)) Le script d'installation ([GuideInstall12](GuideInstallDebian12.md))
assure l'installation de tout les éléments nécessaires au bon fonctionnement de assure l'installation de tout les éléments nécessaires au bon fonctionnement de
ScoDoc. ScoDoc.

8
docs/GuideAdminSys.md
View File

@ -1,12 +1,12 @@
# Guide pour les administrateurs système de ScoDoc # Guide pour les administrateurs système de ScoDoc
ScoDoc 9 est prévu pour fonctionner sur un serveur **Linux Debian 11 (Bullseye)**. ScoDoc 9 est prévu pour fonctionner sur un serveur **Linux Debian 12 (Bookworm)**.
L'installation sur tout autre système n'est **pas supportée**. L'installation sur tout autre système n'est **pas supportée**.
Utilisez un **serveur virtuel** ou un container Docker si vous n'avez pas de machine Debian dédiée. Utilisez un **serveur virtuel** ou un container Docker si vous n'avez pas de machine Debian dédiée.
## Installation ## Installation
* Installation de ScoDoc: [GuideInstallDebian11](GuideInstallDebian11.md) * Installation de ScoDoc: [GuideInstallDebian12](GuideInstallDebian12.md)
* Migration d'un serveur ScoDoc 7 vers la nouvelle version Scodoc 9: [MigrationScoDoc7a9](MigrationScoDoc7a9.md) * Migration d'un serveur ScoDoc 7 vers la nouvelle version Scodoc 9: [MigrationScoDoc7a9](MigrationScoDoc7a9.md)
@ -36,7 +36,7 @@ Utilisez un **serveur virtuel** ou un container Docker si vous n'avez pas de mac
!!! note "Voir aussi" !!! note "Voir aussi"
- [Guide pour les développeurs](GuideDeveloppeurs.md) - [Guide pour les développeurs](GuideDeveloppeurs.md)
- [FAQ](FAQ.md) - [FAQ](FAQ.md)
- [Contacts](Contact.md) - [Contacts](Contact.md)

20
docs/GuideConfig.md
View File

@ -1,7 +1,7 @@
# Prise en main et paramétrage de ScoDoc 9 # Prise en main et paramétrage de ScoDoc 9
Ce document suppose que le logiciel a été installé suivant la procédure décrite dans Ce document suppose que le logiciel a été installé suivant la procédure décrite dans
[GuideInstallDebian11](GuideInstallDebian11.md). [GuideInstallDebian12](GuideInstallDebian12.md).
## Administration en ligne de commande ## Administration en ligne de commande
@ -10,15 +10,15 @@ création d'utilisateurs "super admin", c'est à dire admin pour tous les
départements. Le reste des paramétrages (création de comptes, de formations, départements. Le reste des paramétrages (création de comptes, de formations,
import d'étudiants, etc) se fait à partir du logiciel (web). import d'étudiants, etc) se fait à partir du logiciel (web).
L'administration se fait dans un terminal connecté au serveur (en général via L'administration se fait dans un terminal connecté au serveur (en général via
ssh), en tant qu'utilisateur `scodoc` (*et non* `root`). ssh), en tant qu'utilisateur `scodoc` (*et non* `root`).
Se connecter et initialiser la session ainsi: Se connecter et initialiser la session ainsi:
ssh votre.serveur # si nécessaire ssh votre.serveur # si nécessaire
su scodoc # idem, su scodoc # idem,
# ou tout autre moyen d'ouvrir un shell comme scodoc # ou tout autre moyen d'ouvrir un shell comme scodoc
cd /opt/scodoc cd /opt/scodoc
source venv/bin/activate source venv/bin/activate
@ -64,12 +64,12 @@ où `admin2` est ici le pseudo du nouvel admin.
### Changement du mot de passe d'un utilisateur ### Changement du mot de passe d'un utilisateur
Cette opération peut s'effectuer via la page de gestion web des Cette opération peut s'effectuer via la page de gestion web des
utilisateurs, mais il est parfois commode de le faire depuis la utilisateurs, mais il est parfois commode de le faire depuis la
console: console:
flask user-password LOGIN flask user-password LOGIN
où `LOGIN` est le pseudo de l'utilisateur. Le mot de passe est demandé où `LOGIN` est le pseudo de l'utilisateur. Le mot de passe est demandé
sur la ligne de commande. sur la ligne de commande.
### Création d'un nouveau rôle ### Création d'un nouveau rôle
@ -96,7 +96,7 @@ Ajoute ou retire une permission.
Exemples: Exemples:
flask user-role dupont flask user-role dupont
affiche les rôles de l'utilisateur `dupont`. affiche les rôles de l'utilisateur `dupont`.
@ -122,7 +122,7 @@ Ces commandes sont utilisées par le script de migration de ScoDoc 7 à ScoDoc 9
#### Comptes utilisateurs #### Comptes utilisateurs
Toujours migrer les comptes utilisateurs avant d'importer les Toujours migrer les comptes utilisateurs avant d'importer les
départements. départements.
flask import-scodoc7-users flask import-scodoc7-users
@ -353,7 +353,7 @@ département, qui à son tour peut déléguer des droits.
!!! note "Voir aussi" !!! note "Voir aussi"
- [Guide installation](GuideInstallDebian11.md) - [Guide installation](GuideInstallDebian12.md)
- [Gestion des utilisateurs](AdminUsers.md) - [Gestion des utilisateurs](AdminUsers.md)
- [Rôles et permissions](ConfigPermissionsDept.md) - [Rôles et permissions](ConfigPermissionsDept.md)
- [Configuration des envois d'emails](ConfigEmail.md) - [Configuration des envois d'emails](ConfigEmail.md)

2
docs/GuideDeveloppeurs.md
View File

@ -153,7 +153,7 @@ Note: la mise à jour par `apt` recrée le virtualenv à chaque fois.
- [Conventions de codage](DevConventions.md) - [Conventions de codage](DevConventions.md)
- [API ScoDoc 9](ScoDoc9API.md) - [API ScoDoc 9](ScoDoc9API.md)
- [Guide installation](GuideInstallDebian11.md) - [Guide installation](GuideInstallDebian12.md)
- [Gestion des utilisateurs](AdminUsers.md) - [Gestion des utilisateurs](AdminUsers.md)
- [Guide administrateur ScoDoc](GuideAdminSys.md) - [Guide administrateur ScoDoc](GuideAdminSys.md)
- [FAQ](FAQ.md) - [FAQ](FAQ.md)

12
docs/GuideInstallDebian12.md
View File

@ -17,7 +17,7 @@ donc installer et configurer ScoDoc avec des connaissances réduites sur le
système Linux. système Linux.
Cette documentation est prévue pour installer ScoDoc version 9 sur un système Cette documentation est prévue pour installer ScoDoc version 9 sur un système
[Debian](http://www.debian.org) 12 (Bullseye, stable) s'exécutant sur une [Debian](http://www.debian.org) 12 (Bookworm, stable) s'exécutant sur une
machine intel-like **64bits** (architecture **AMD64** sur Intel/AMD, ou machine intel-like **64bits** (architecture **AMD64** sur Intel/AMD, ou
**aarch64** sur Apple ARM). Debian s'installe facilement en cinq minutes, sur **aarch64** sur Apple ARM). Debian s'installe facilement en cinq minutes, sur
une machine normale ou un serveur virtualisé. Il est **vivement déconseillé** de une machine normale ou un serveur virtualisé. Il est **vivement déconseillé** de
@ -38,7 +38,7 @@ VirtualBox ou VMWare, ou UTM sur Mac). L'installation de ScoDoc va en effet
modifier de nombreux paramètres de votre système Linux (serveur web, firewall, modifier de nombreux paramètres de votre système Linux (serveur web, firewall,
serveur SQL, messagerie, ...). serveur SQL, messagerie, ...).
## 1) Préalable: configurer un serveur linux ## 1) Préalable: configurer un serveur Linux
Le serveur devrait être accessible depuis Internet. Le serveur devrait être accessible depuis Internet.
@ -108,7 +108,7 @@ Checklist minimale de votre système Linux Debian:
changer leurs mots de passe (bien d'autres fonctions dépendent des mails). changer leurs mots de passe (bien d'autres fonctions dépendent des mails).
Au besoin, revoir la configuration avec `dpkg-reconfigure postfix` (voir Au besoin, revoir la configuration avec `dpkg-reconfigure postfix` (voir
aussi [envoi des courriers électroniques](ProblemesMail.md)). aussi [envoi des courriers électroniques](ProblemesMail.md)).
1. Vérifiez que votre serveur est accessible depuis une autre machine de votre 1. Vérifiez que votre serveur est accessible depuis une autre machine de votre
réseau (voire d'Internet): par exemple `ping serveur.exemple.fr`. réseau (voire d'Internet): par exemple `ping serveur.exemple.fr`.
1. Date et heure: vérifier que les dates et heure sont correctes, même après 1. Date et heure: vérifier que les dates et heure sont correctes, même après
@ -162,7 +162,7 @@ redémarrer le service:
Dans les cas compliqués, il est possible qu'il vous faille configurer d'autres Dans les cas compliqués, il est possible qu'il vous faille configurer d'autres
éléments, voir par exemple éléments, voir par exemple
[ce post sur Stack Overflow](https://stackoverflow.com/questions/9445489/performing-http-requests-with-curl-using-proxy). [ce post sur Stack Overflow](https://stackoverflow.com/questions/9445489/performing-http-requests-with-curl-using-proxy).
#### Note sur l'install dans un container LXC #### Note sur l'install dans un container LXC
Il y a deux possibilités : Il y a deux possibilités :
@ -262,7 +262,7 @@ ou bien le créer afin qu'il contienne juste cette ligne:
apt-get install nginx apt-get install nginx
``` ```
S'assurer que le logiciel `nginx` s'est bien installé. En cas de problème se S'assurer que le logiciel `nginx` s'est bien installé. En cas de problème se
référer à sa doc (par exemple, si référer à sa doc (par exemple, si
[votre serveur ne supporte pas [votre serveur ne supporte pas
IPv6](https://techglimpse.com/nginx-error-address-family-solution/)). IPv6](https://techglimpse.com/nginx-error-address-family-solution/)).
@ -282,7 +282,7 @@ utilisateur `scodoc` qui sera utilisé par le serveur.
``` ```
### 2.2) Configuration des logiciels et des données ### 2.2) Configuration des logiciels et des données
Lancer le script suivant en tant que `root` sur votre serveur nouvellement installé: Lancer le script suivant en tant que `root` sur votre serveur nouvellement installé:
```bash ```bash

14
docs/MigrationDonneesScoDoc.md
View File

@ -1,5 +1,5 @@
# Migration d'une installation existante de ScoDoc # Migration d'une installation existante de ScoDoc
Marche à suivre pour transférer les données d'un serveur ScoDoc déjà existant vers un autre. Cas d'usage typiques: Marche à suivre pour transférer les données d'un serveur ScoDoc déjà existant vers un autre. Cas d'usage typiques:
* changement de machine physique * changement de machine physique
@ -10,8 +10,8 @@ Marche à suivre pour transférer les données d'un serveur ScoDoc déjà exista
Toutes les données seront copiées: bases SQL, configurations, photos, archives, logs. Toutes les données seront copiées: bases SQL, configurations, photos, archives, logs.
## Principe ## Principe
Au lieu de mettre à jour le système Debian, il est préférable de **réinstaller complètement un nouveau serveur**. En effet, ScoDoc utilise certains composants qui ne sont pas fournis dans les versions adéquates par Debian. Au lieu de mettre à jour le système Debian, il est préférable de **réinstaller complètement un nouveau serveur**. En effet, ScoDoc utilise certains composants qui ne sont pas fournis dans les versions adéquates par Debian.
L'expérience montre qu'il est plus rapide de **tout réinstaller** sans se poser de questions. D'ailleurs, la plupart des installations étant sur des serveurs virtualisés, cette méthode est souvent plus simple et évite de toucher au serveur en production. J'insiste : **ne tentez pas de mettre à jour le système Debian de votre ancien serveur**, c'est une perte de temps. L'expérience montre qu'il est plus rapide de **tout réinstaller** sans se poser de questions. D'ailleurs, la plupart des installations étant sur des serveurs virtualisés, cette méthode est souvent plus simple et évite de toucher au serveur en production. J'insiste : **ne tentez pas de mettre à jour le système Debian de votre ancien serveur**, c'est une perte de temps.
@ -22,14 +22,14 @@ Le principe est donc:
3. Copier les données d'un serveur à l'autre (scripts fournis); 3. Copier les données d'un serveur à l'autre (scripts fournis);
4. Tester, puis le cas échéant couper l'ancien serveur et le remplacer par le nouveau. 4. Tester, puis le cas échéant couper l'ancien serveur et le remplacer par le nouveau.
## Marche à suivre détaillée
## Marche à suivre détaillée ### Installation de Debian et ScoDoc
### Installation de Debian et ScoDoc
Voir les instructions ici: [GuideInstallDebian11](GuideInstallDebian11.md).
Voir les instructions ici: [GuideInstallDebian12](GuideInstallDebian12.md).
### Copie des données d'un serveur à l'autre
### Copie des données d'un serveur à l'autre
Il est important de suivre rigoureusement et pas à pas cette procédure: Il est important de suivre rigoureusement et pas à pas cette procédure:
1. S'assurer que le serveur de départ est à jour (pour avoir le bon script de sauvegarde!): voir [MisesAJour](MisesAJour.md) 1. S'assurer que le serveur de départ est à jour (pour avoir le bon script de sauvegarde!): voir [MisesAJour](MisesAJour.md)

25
docs/MigrationScoDoc7a9.md
View File

@ -1,7 +1,7 @@
# Migration des données ScoDoc 7 vers ScoDoc 9 # Migration des données ScoDoc 7 vers ScoDoc 9
On peut installer à partir de zéro (cas 1), ou sur une machine ayant déjà un ScoDoc 7 On peut installer à partir de zéro (cas 1), ou sur une machine ayant déjà un ScoDoc 7
et migrer les données (cas 2). et migrer les données (cas 2).
## Cas 1: Migration d'une installation ScoDoc 7 sur un nouveau serveur ## Cas 1: Migration d'une installation ScoDoc 7 sur un nouveau serveur
@ -12,7 +12,7 @@ basculer d'une version à l'autre.
Dans ce cas, la migration va se faire en suivant les étapes, détaillées plus loin: Dans ce cas, la migration va se faire en suivant les étapes, détaillées plus loin:
1. installer le nouveau serveur Linux Debian 11 et ScoDoc 9; 1. installer le nouveau serveur Linux Debian 11 et ScoDoc 9;
2. sauvegarder les données de ScoDoc7 depuis le serveur de production **et l'arrêter**; 2. sauvegarder les données de ScoDoc7 depuis le serveur de production **et l'arrêter**;
3. charger les données ScoDoc 7 sur le nouveau serveur; 3. charger les données ScoDoc 7 sur le nouveau serveur;
@ -23,9 +23,9 @@ Si vous venez d'installer ScoDoc 9, passez directement à l'**étape 3**.
### Étape 1: Installer le nouveau serveur ### Étape 1: Installer le nouveau serveur
Installer le nouveau serveur avec Debian 11 et ScoDoc 9. Installer le nouveau serveur avec Debian 12 et ScoDoc 9.
Voir [GuideInstallDebian11](GuideInstallDebian11.md). Voir [GuideInstallDebian12](GuideInstallDebian12.md).
Vérifier que tout fonctionne avant d'aller plus loin. Vérifier que tout fonctionne avant d'aller plus loin.
@ -41,7 +41,7 @@ Ouvrir un terminal en tant que `root`sur l'ancien serveur ScoDoc 7.
# Export des données # Export des données
./save_scodoc7_data.sh /tmp/sauvegarde-scodoc7 ./save_scodoc7_data.sh /tmp/sauvegarde-scodoc7
Attention à l'espace disque: au besoin, faire le ménage ou montez un disque supplémentaire. Attention à l'espace disque: au besoin, faire le ménage ou montez un disque supplémentaire.
Notez que cette migration ne fonctionne qu'à partir de la dernière version de Notez que cette migration ne fonctionne qu'à partir de la dernière version de
ScoDoc 7. Si vous avez une version plus ancienne, mettez-la d'abord à jour. ScoDoc 7. Si vous avez une version plus ancienne, mettez-la d'abord à jour.
@ -140,24 +140,25 @@ officielle](https://www.debian.org/releases/bullseye/mips64el/release-notes/ch-u
est longue, mais en réalité c'est très simple et prends moins de 10 minutes, est longue, mais en réalité c'est très simple et prends moins de 10 minutes,
sauf si vous avez configuré votre système de façon exotique. sauf si vous avez configuré votre système de façon exotique.
Nombreux tutos disponibles, voir [par exemple Nombreux tutos disponibles, voir [par exemple
celui-ci](https://www.cyberciti.biz/faq/update-upgrade-debian-10-to-debian-11-bullseye/). celui-ci](https://www.cyberciti.biz/faq/update-upgrade-debian-10-to-debian-11-bullseye/).
Attention, il faut désinstaller Apache (avant ou après upgrade Linux), car Attention, il faut désinstaller Apache (avant ou après upgrade Linux), car
ScoDoc 9 utilise un autre serveur web (nginx) qui serait en conflit: ScoDoc 9 utilise un autre serveur web (nginx) qui serait en conflit:
# peut être utile pour récuperer vos certificats SSL ? # peut être utile pour récuperer vos certificats SSL ?
mv /etc/apache2 /etc/apache2.old mv /etc/apache2 /etc/apache2.old
apt-get remove --purge apache2 apt-get remove --purge apache2
### 3. Installer ScoDoc 9 ### 3. Installer ScoDoc 9
Voir [la section 2 du guide d'installation](GuideInstallDebian11.md#2-installation-de-scodoc-sur-debian).
Voir [la section 2 du guide d'installation](GuideInstallDebian1é.md#2-installation-de-scodoc-sur-debian).
Vérifier que tout fonctionne avant d'aller plus loin. Vérifier que tout fonctionne avant d'aller plus loin.
### 4. Migrer vos données ScoDoc 7 ### 4. Migrer vos données ScoDoc 7
Les données sont restées dans /opt/scodoc7. Les données sont restées dans `/opt/scodoc7`.
Lancer le script suivant en tant que `root`: Lancer le script suivant en tant que `root`:
@ -186,5 +187,3 @@ Au besoin, réglez la fonction de calcul du **bonus sport&culture** via la page
"configuration" accessible depuis la page d'accueil en tant qu'admin uniquement. "configuration" accessible depuis la page d'accueil en tant qu'admin uniquement.
Célébrez ! Célébrez !

5
docs/SauvegardesBases.md
View File

@ -86,7 +86,8 @@ comptes utilisateurs.
# en tant que root... # en tant que root...
systemctl stop scodoc9 # arret du serveur systemctl stop scodoc9 # arret du serveur
su - scodoc su - scodoc
dropdb SCODOC # <<< votre base production cd /opt/scodoc
dropdb SCODOC # <<< votre base production
createdb -E UTF-8 SCODOC createdb -E UTF-8 SCODOC
pg_restore -d SCODOC /tmp/SCODOC_pgdump # (nom du fichier dump) pg_restore -d SCODOC /tmp/SCODOC_pgdump # (nom du fichier dump)
source venv/bin/activate source venv/bin/activate
@ -111,7 +112,7 @@ script
Ce script va générer une archive (`tar`, format `.tgz`) contenant non seulement Ce script va générer une archive (`tar`, format `.tgz`) contenant non seulement
la base de données SQL mais aussi tous les fichiers générés par votre ScoDoc: la base de données SQL mais aussi tous les fichiers générés par votre ScoDoc:
photos, configurations locales, archives, PV de jurys, logos, etc (tout ceci photos, configurations locales, archives, PV de jurys, logos, etc (tout ceci
étant stocké sous `/opt/scodoc-data`). étant stocké sous `/opt/scodoc-data`).
Attention à l'espace disque: le répertoire destination (`/tmp`dans l'exemple Attention à l'espace disque: le répertoire destination (`/tmp`dans l'exemple
ci-dessus) doit avoir de l'espace (sinon utilisez un autre répertoire dans ci-dessus) doit avoir de l'espace (sinon utilisez un autre répertoire dans

2
mkdocs.yml
View File

@ -52,7 +52,7 @@ nav:
- "FAQ": FAQ.md - "FAQ": FAQ.md
- Installation: - Installation:
- "Guide administration": GuideAdminSys.md - "Guide administration": GuideAdminSys.md
- "Installation": GuideInstallDebian11.md - "Installation": GuideInstall12.md
- "Mises à jour": MisesAJour.md - "Mises à jour": MisesAJour.md
- "Interfaces SI": InterrogationPortail.md - "Interfaces SI": InterrogationPortail.md
- "Publication des notes": PublicationEtudiants.md - "Publication des notes": PublicationEtudiants.md