forked from ScoDoc/DocScoDoc
MAJ conseils dev. Suppression de qq docs obsolètes.
This commit is contained in:
parent
24acf76dd4
commit
bc6b790bbf
@ -7,13 +7,38 @@ Quelques indications pour développer avec ScoDoc 7.x, à adapter à vos goûts
|
|||||||
Il est confortable de développer dans une VM (un container Docker ferait
|
Il est confortable de développer dans une VM (un container Docker ferait
|
||||||
aussi bien l'affaire).
|
aussi bien l'affaire).
|
||||||
|
|
||||||
## Conseils pour VirtualBox
|
## Conseils pour la machine virtuelle
|
||||||
[VirtualBox](https://www.virtualbox.org/) est facile à installer sur Mac, Linux ou Windows. Créer une VM avec Debian 10, et suivre la [procédure habituelle d'installation de ScoDoc](GuideInstallDebian11.md). XXX
|
|
||||||
|
|
||||||
En général, vous préférez développer sur la machine hôte pour disposer de votre éditeur préféré. Mais vous exécutez ScoDoc dans la VM.
|
[VirtualBox](https://www.virtualbox.org/) est facile à installer sur Linux ou
|
||||||
|
Windows. Créer une VM avec Debian 10, et suivre la [procédure habituelle
|
||||||
|
d'installation de ScoDoc](GuideInstallDebian11.md).
|
||||||
|
|
||||||
### Configuration réseau
|
Sur les Macs anciens (processeurs Intel), VirtualBox fonctionne bien. Sur les
|
||||||
La VM a besoin d'accéder à Internet pour l'installation, et aussi pour les mises à jour et peut-être certains tests que vous voudrez lancer. L'accès à la VM depuis l'hôte doit être possible via un réseau privé interne (car vous ne serez pas toujours conencté à Internet, et ne souhaitez pas que l'on accède à votre serveur de test de l'extérieur).
|
modèles "M1" (Apple Silicon), je conseille d'utiliser
|
||||||
|
[UTM](https://mac.getutm.app/) qui est facile à installer et très performant. On
|
||||||
|
installe alors une VM avec la distribution Linux Debian pour l'architecture
|
||||||
|
`arm64` (nous ne produisons pas de paquets Debian `arm64` pour ScoDoc 9, mais
|
||||||
|
l'installation est simple, ne pas hésiter à demander sur le Discord).
|
||||||
|
|
||||||
|
En général, vous préférez développer sur la machine hôte pour disposer de votre
|
||||||
|
éditeur préféré, mais exécutez ScoDoc dans la VM.
|
||||||
|
|
||||||
|
### Éditeur de texte / IDE
|
||||||
|
Si vous êtes expérimenté, vous avez vos outils préférés. Mais si vous débutez,
|
||||||
|
surtout pour un environnement de développement distant (le code développé tourne
|
||||||
|
dans une machine virtuelle ou réelle séparée de votre machine de burea), nous
|
||||||
|
vous conseillons **VS Code** avec le module
|
||||||
|
[*Remote-SSH*](https://code.visualstudio.com/docs/remote/ssh). Ceci vous évite
|
||||||
|
de fastidieuses configurations de partage de fichiers entre les machine, il
|
||||||
|
suffit d'une connexion SSH fonctionnelle.
|
||||||
|
|
||||||
|
### Configuration réseau de VirtualBox
|
||||||
|
|
||||||
|
La VM a besoin d'accéder à Internet pour l'installation, et aussi pour les mises
|
||||||
|
à jour et peut-être certains tests que vous voudrez lancer. L'accès à la VM
|
||||||
|
depuis l'hôte doit être possible via un réseau privé interne (car vous ne serez
|
||||||
|
pas toujours conencté à Internet, et ne souhaitez pas que l'on accède à votre
|
||||||
|
serveur de test de l'extérieur).
|
||||||
|
|
||||||
Modifier la config réseau via l'UI graphique de VirtualBox, la VM étant éteinte.
|
Modifier la config réseau via l'UI graphique de VirtualBox, la VM étant éteinte.
|
||||||
|
|
||||||
@ -33,7 +58,8 @@ Dans le Debian, j'utilise `/etc/network/interfaces`
|
|||||||
|
|
||||||
(le `enp0s3` désigne chez moi l'`Adapter 1`, mais c'est susceptible de changer. Normalement, l'installeur créé ce fichier )
|
(le `enp0s3` désigne chez moi l'`Adapter 1`, mais c'est susceptible de changer. Normalement, l'installeur créé ce fichier )
|
||||||
|
|
||||||
Pour lancer l'interface externe , quand on a besoin d'accéder à Internet depuis la VM (en fait assez rarement):
|
Pour lancer l'interface externe , quand on a besoin d'accéder à Internet depuis
|
||||||
|
la VM (en fait assez rarement):
|
||||||
|
|
||||||
dhclient enp0s8
|
dhclient enp0s8
|
||||||
|
|
||||||
@ -46,13 +72,20 @@ Modifier le `/etc/hosts` (ou équivalent) de l'hôte, et y ajouter l'IP de votre
|
|||||||
|
|
||||||
|
|
||||||
### Partage de fichiers
|
### Partage de fichiers
|
||||||
Pour éditer votre code au chaud sur votre hôte, il y a plein de solutions. L'une consiste à laisser le code dans la VM, mais de monter un répertoire (par exemple `/opt`) sur l'hôte, par exemple via `sshfs`.
|
Pour éditer votre code au chaud sur votre hôte, il y a plein de solutions.
|
||||||
|
La plus simple, déjà mentionnée, consiste à passer par une connexion SSH (VS
|
||||||
|
Code propose un module dédié très simple et performant, mais tout montage de
|
||||||
|
type `sshfs`peut aussi faire l'affaire).
|
||||||
|
|
||||||
Une autre solution (que j'utilise sur mon MacBook), est de laisser le source (clone git) sur l'hôte, et de partager ce répertoire avec la VM.
|
|
||||||
|
|
||||||
Dans VirtualBox / config. VM / Dossiers partagés, ajouter un partage. Par exemple, vous mettez vos sources sur l'hôte dans `~/src`, et dans la VM sur `/src`.
|
Une autre solution est de laisser le source (clone git) sur l'hôte, et de
|
||||||
Dans ScoDoc, `/opt/scodoc/Products/ScoDoc` est alors un lien symbolique vers votre `src/ScoDoc`.
|
partager ce répertoire avec la VM. Dans VirtualBox / config. VM / Dossiers
|
||||||
|
partagés, ajouter un partage. Par exemple, vous mettez vos sources sur l'hôte
|
||||||
|
dans `~/src`, et dans la VM sur `/src`.
|
||||||
|
Dans ScoDoc, `/opt/scodoc/Products/ScoDoc` est alors un lien symbolique vers
|
||||||
|
votre `src/ScoDoc`.
|
||||||
|
|
||||||
|
#### Détails sur les partages avec VirtualBox
|
||||||
Pour pouvoir utiliser des liens symboliques dans le partage:
|
Pour pouvoir utiliser des liens symboliques dans le partage:
|
||||||
|
|
||||||
VBoxManage setextradata "Debian11" VBoxInternal2/SharedFoldersEnableSymlinksCreate/src 1
|
VBoxManage setextradata "Debian11" VBoxInternal2/SharedFoldersEnableSymlinksCreate/src 1
|
||||||
@ -75,7 +108,7 @@ Il arrive (?) que Virtual Box change les droits unix sur les fichiers partagés.
|
|||||||
|
|
||||||
git diff -p -R --no-color | grep -E "^(diff|(old|new) mode)" --color=never | git apply
|
git diff -p -R --no-color | grep -E "^(diff|(old|new) mode)" --color=never | git apply
|
||||||
|
|
||||||
# Interaction avec ScoDoc 7
|
# Interaction avec ScoDoc 7 (ancien ScoDoc, avant l'été 2021)
|
||||||
|
|
||||||
ScoDoc 7 utilise Zope, et ce n'est pas un environnement commode pour débugguer.
|
ScoDoc 7 utilise Zope, et ce n'est pas un environnement commode pour débugguer.
|
||||||
|
|
||||||
|
|||||||
@ -11,10 +11,6 @@ Utilisez un **serveur virtuel** ou un container Docker si vous n'avez pas de mac
|
|||||||
* 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)
|
||||||
|
|
||||||
|
|
||||||
(Les personnes ayant besoin d'installer l'ancienne version ScoDoc 7 peuvent se
|
|
||||||
référer à [GuideInstallDebianDix](GuideInstallDebianDix.md) ou
|
|
||||||
[GuideInstallDebianNeuf](GuideInstallDebianNeuf.md).)
|
|
||||||
|
|
||||||
## Mises à jour et sauvegardes
|
## Mises à jour et sauvegardes
|
||||||
|
|
||||||
* [Mettre à jour du logiciel (nouvelles versions)](MisesAJour.md)
|
* [Mettre à jour du logiciel (nouvelles versions)](MisesAJour.md)
|
||||||
|
|||||||
@ -20,17 +20,17 @@ Informations pour les développeurs souhaitant étendre ou modifier ScoDoc.
|
|||||||
Quelques conseils, indications et mémos pour les développeurs sur ScoDoc version 9.
|
Quelques conseils, indications et mémos pour les développeurs sur ScoDoc version 9.
|
||||||
|
|
||||||
### Installation d'un serveur de développement
|
### Installation d'un serveur de développement
|
||||||
[Quelques conseils mouvants pour configurer votre serveur de développement](ConseilServeurDev.md)
|
[Quelques conseils pour configurer votre serveur de développement](ConseilServeurDev.md)
|
||||||
|
|
||||||
### Style et formatage du code
|
### Style et formatage du code
|
||||||
L'ancienneté de la base de code a rendu le style un peu incohérent, mais cela
|
L'ancienneté de la base de code a rendu le style un peu incohérent, mais cela
|
||||||
s'est amélioré avec ScoDoc 9 (respect PEP 8).
|
s'est nettement amélioré avec ScoDoc 9 (respect PEP 8).
|
||||||
|
|
||||||
Le code doit être formatté avec [`black`](https://black.readthedocs.io/) avant
|
Le code DOIT être formatté avec [`black`](https://black.readthedocs.io/) avant
|
||||||
tout commit (configurez votre éditeur pour appeler `black` à l'enregistrement).
|
tout commit (configurez votre éditeur pour appeler `black` à l'enregistrement).
|
||||||
|
|
||||||
#### Documentation
|
#### Documentation
|
||||||
On adoptera le style "Google": <https://google.github.io/styleguide/pyguide.html#383-functions-and-methods>
|
On pourra adopter le style "Google": <https://google.github.io/styleguide/pyguide.html#383-functions-and-methods>
|
||||||
|
|
||||||
Exemple:
|
Exemple:
|
||||||
"""Description résumée de la fonction
|
"""Description résumée de la fonction
|
||||||
@ -58,14 +58,16 @@ Exemple:
|
|||||||
|
|
||||||
Le dépôt est <https://scodoc.org/git/viennet/ScoDoc>
|
Le dépôt est <https://scodoc.org/git/viennet/ScoDoc>
|
||||||
|
|
||||||
La branche `master` est celle de ScoDoc 9. La branche `Scodoc7` est l'ancienne
|
La branche `master` est celle de ScoDoc 9, d'où sont issues les paquets
|
||||||
(jusqu'à septembre 2021) version en production.
|
distribués (*releases*). Les développements ont lieu sur d'autres branches
|
||||||
|
(`api`, `dev92`, `entreprises`, ...) avant d'être intégrés après tests.
|
||||||
|
La branche `Scodoc7` était l'ancienne (jusqu'à septembre 2021) version de ScoDoc.
|
||||||
|
|
||||||
Ci-dessous quelques pense-bête qui peuvent servir.
|
Ci-dessous quelques pense-bête qui peuvent servir.
|
||||||
#### Hot fixes (internes)
|
#### Hot fixes (internes)
|
||||||
|
|
||||||
Pour les développeurs internes (écriture sur le dépôt master), un exemple
|
Pour les développeurs internes (écriture sur le dépôt master), un exemple
|
||||||
basique:
|
basique illustrant le cycle de développement:
|
||||||
|
|
||||||
# Créer une branche
|
# Créer une branche
|
||||||
# si besoin (travail en cours), utiliser git stash avant
|
# si besoin (travail en cours), utiliser git stash avant
|
||||||
@ -82,10 +84,13 @@ basique:
|
|||||||
|
|
||||||
# éventuellement: git stash pop
|
# éventuellement: git stash pop
|
||||||
|
|
||||||
|
Dans la plupart des cas, on travaillera sur son propre dépot (clone du dépt
|
||||||
|
origine), et on proposera une *pull request* (PR, *demande d'ajout* en français).
|
||||||
|
|
||||||
#### Mettre à jour votre branche
|
#### Mettre à jour votre branche
|
||||||
|
|
||||||
Vous travaillez dans votre branche `ma_branche`. Pour lui appliquer les mises à
|
Quand vous travaillez dans votre branche `ma_branche`, pour lui appliquer les
|
||||||
jour de `master` (remote):
|
mises à jour de `master` (remote), faire:
|
||||||
```bash
|
```bash
|
||||||
git pull origin master
|
git pull origin master
|
||||||
```
|
```
|
||||||
|
|||||||
@ -1,4 +0,0 @@
|
|||||||
|
|
||||||
<img src="/img/alert.png" style="vertical-align: bottom; margin:0 0 0 0;" alt="/!\" /> '''Attention: document obsolète pour une version ancienne de Debian. Voir [GuideInstallDebianDix](GuideInstallDebianDix.md) pour l'installation normale de !ScoDoc !
|
|
||||||
|
|
||||||
|
|
||||||
@ -110,11 +110,27 @@ Checklist minimale de votre système Linux Debian:
|
|||||||
|
|
||||||
#### Configuration si utilisation d'un proxy
|
#### Configuration si utilisation d'un proxy
|
||||||
Si votre accès à Internet passe par un proxy, l'indiquer au moment de
|
Si votre accès à Internet passe par un proxy, l'indiquer au moment de
|
||||||
l'installation Debian. Il est possible qu'il vous faille configurer d'autres
|
l'installation Debian.
|
||||||
|
|
||||||
|
Ensuite, dans ScoDoc, indiquer votre proxy: pour cela, éditer le fichier
|
||||||
|
```/opt/scodoc/.env```
|
||||||
|
et ajouter les variables d'environnement nécessaires. Typiquement, il s'agit de :
|
||||||
|
```
|
||||||
|
HTTP_PROXY=http://proxy.univ-xxx.fr:1234
|
||||||
|
HTTPS_PROXY=http://proxy.univ-xxx.fr:1234
|
||||||
|
```
|
||||||
|
Après modification de ce fichier (qui _doit_ être lisible par l'utilisateur `scodoc`),
|
||||||
|
redémarrer le service:
|
||||||
|
```
|
||||||
|
sudo systemctl restart scodoc
|
||||||
|
```
|
||||||
|
|
||||||
|
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](
|
[ce post sur Stack Overflow](
|
||||||
https://stackoverflow.com/questions/9445489/performing-http-requests-with-curl-using-proxy).
|
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 :
|
||||||
|
|||||||
@ -1,162 +0,0 @@
|
|||||||
|
|
||||||
# Installation de ScoDoc sur Debian 10 (Buster)
|
|
||||||
Ce document décrit la procédure d'installation et de configuration de ScoDoc.
|
|
||||||
Cette procédure doit être effectué sur la machine serveur avec un accès administrateur (root).
|
|
||||||
|
|
||||||
*Si vous avez déjà une installation ScoDoc version 7 (en Debian 7, 8 ou 9), voir aussi [MigrationDonneesScoDoc](MigrationDonneesScoDoc.md)*
|
|
||||||
|
|
||||||
ScoDoc est livré avec des scripts d'installation qui configurer presque automatiquement votre serveur (serveur web, base de données, etc): vous pouvez donc installer et configurer ScoDoc avec des connaissances réduites sur le système Linux.
|
|
||||||
|
|
||||||
Cette documentation est prévue pour installer ScoDoc sur un système [Debian](http://www.debian.org) 10 (Buster) s'exécutant sur une machine intel-like **64bits** (architecture **AMD64**). Debian s'installe facilement en une quinzaine de minutes, sur une machine normale ou un serveur virtualisé. Il est **très déconseillé** de tenter l'installation sur une autre version, à moins de disposer de temps et de bonnes connaissances sur Linux et les paquetages Python.
|
|
||||||
|
|
||||||
Merci de me signaler tout problème (emmanuel.viennet@gmail.com)
|
|
||||||
|
|
||||||
|
|
||||||
- Note 1: l'image du CD d'installation de Debian (amd64) peut se trouver ici: [https://www.debian.org/distrib/netinst](https://www.debian.org/distrib/netinst.md), choisir une version "petits CD" pour **amd64** (*Il est indispensable d'utiliser une version 64 bits ! *)
|
|
||||||
|
|
||||||
- Note 2: si quelqu'un produit, teste et documente une image Docker, merci de la partager (écrire à scodoc-devel).
|
|
||||||
|
|
||||||
|
|
||||||
<img src="/img/alert.png" style="vertical-align: bottom; margin:0 0 0 0;" alt="/!\" /> Important: La procédure d'installation décrite ci-dessous suppose que ScoDoc va s'exécuter sur un serveur dédié. Pour faire des tests, utilisez un serveur virtuel (comme VirtualBox ou VMWare). L'installation ci-dessous va en effet modifier de nombreux paramètres de votre système linux (serveur web, firewall, serveur SQL, messagerie, ...).
|
|
||||||
|
|
||||||
|
|
||||||
## Préalable: configurer un serveur linux
|
|
||||||
Le serveur devrait être accessible depuis Internet. Seul le port 443 (https) est utilisé par ScoDoc. Il est recommandé que le serveur puisse envoyer du mail (smtp).
|
|
||||||
|
|
||||||
Nous recommandons d'effectuer une installation standard de Debian par le réseau (netinst).
|
|
||||||
Durant l'installation de Debian, lorsqu'il demande "logiciels à installer", tout décocher sauf "Serveur SSH" et "Utilitaires standard du système". Le script d'installation de ScoDoc se chargera ensuite d'installer tous les éléments nécessaires (serveur web, messagerie, etc.).
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Points à vérifier avant d'installer ScoDoc
|
|
||||||
Checklist minimale de votre système Linux Debian:
|
|
||||||
|
|
||||||
1. Connexion à Internet: le réseau doit être accessible. En effet, le script d'installation va installer des paquetages du système Debian puis télécharger la dernière mise à jour du logiciel ScoDoc (à partir du serveur Subversion).
|
|
||||||
1. Vérifiez la connectivité, par exemple:
|
|
||||||
```
|
|
||||||
ping www.univ-paris13.fr
|
|
||||||
(quitter avec ctrl-c)
|
|
||||||
cd /tmp
|
|
||||||
wget --no-check-certificate https://www-lipn.univ-paris13.fr/projects/scodoc
|
|
||||||
# doit créer un fichier nomme "scodoc" contenant du code HTML
|
|
||||||
```
|
|
||||||
3. Nom DNS: le serveur doit avoir un nom ("serveur.exemple.fr") connu dans le DNS (local ou public). Pour des tests, vous pouvez vous passer de DNS, mais dans ce cas le nom de votre serveur sera son adresse IP (eg 192.168.0.10) et il ne sera peut être pas accessible de l'extérieur.
|
|
||||||
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".
|
|
||||||
1. Date et heure: vérifier que les dates et heure sont correctes, même après reboot. L'utilisation d'un serveur de temps (ntp) est recommandée (`aptitude install ntp`), et éventuellement `dpkg-reconfigure tzdata`).
|
|
||||||
1. Cette liste est très incomplète... et n'oubliez pas: avant de passer en production, mettez en place des sauvegardes sérieuses !
|
|
||||||
|
|
||||||
|
|
||||||
#### Configuration si utilisation d'un proxy
|
|
||||||
Si votre serveur doit passer par un proxy pour accéder à Internet:
|
|
||||||
1. Configurer wget: placer ceci dans `/root/.bashrc` (par exemple)
|
|
||||||
```
|
|
||||||
export http_proxy=http://my-proxy-server.com:my-proxy-port/
|
|
||||||
export https_proxy=$http_proxy
|
|
||||||
```
|
|
||||||
|
|
||||||
2. Configurer le client svn
|
|
||||||
dans `/root/.subversion/servers` dé-commenter et compléter les lignes:
|
|
||||||
```
|
|
||||||
[global]
|
|
||||||
http-proxy-host = my-proxy-server
|
|
||||||
http-proxy-port = my-proxy-port
|
|
||||||
```
|
|
||||||
(attention bien enlever l'espace du début de ligne).
|
|
||||||
|
|
||||||
|
|
||||||
## Installation de ScoDoc
|
|
||||||
1. Récupérer et ouvrir le logiciel (en tant que root):
|
|
||||||
```
|
|
||||||
sudo su # si necessaire pour passer root
|
|
||||||
cd /opt
|
|
||||||
wget http://www-l2ti.univ-paris13.fr/~viennet/ScoDoc/builds/scodoc-1851.tgz
|
|
||||||
tar xfz scodoc-1851.tgz
|
|
||||||
```
|
|
||||||
Cette archive contient ScoDoc, Zope et quelques outils tiers.
|
|
||||||
<img src="/img/alert.png" style="vertical-align: bottom; margin:0 0 0 0;" alt="/!\" /> vous pouvez installer ailleurs que dans /opt, mais il faudra alors éditer plusieurs scripts (non recommandé).
|
|
||||||
|
|
||||||
|
|
||||||
<img src="/img/alert.png" style="vertical-align: bottom; margin:0 0 0 0;" alt="/!\" /> Les commandes ci-dessous sont à exécuter dans un terminal ouvert en tant que **root** sur le serveur. Vous pouvez utiliser `su` (ou `sudo su`) pour devenir **root**).
|
|
||||||
|
|
||||||
1. **Mettre à jour les sources**. Va télécharger les sources à jour, et le script d'installation:
|
|
||||||
```
|
|
||||||
cd /opt/scodoc/Products/ScoDoc
|
|
||||||
apt install subversion
|
|
||||||
svn up
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
3. **Configurer le logiciel**. Attention: durant cette étape, de nombreux paquets et fichiers de configuration de votre système linux vont être modifiés. Si vous préférez effectuer vous même l'installation (vous êtes développeur ou avez des besoins particuliers), lisez et adaptez le script.
|
|
||||||
|
|
||||||
<img src="/img/alert.png" style="vertical-align: bottom; margin:0 0 0 0;" alt="/!\" /> je répète, le script `install_debian10.sh` va reconfigurer beaucoup de choses sur votre serveur. Il suppose que la machine vient d'être installée et en gros qu'elle va servir principalement pour ScoDoc.
|
|
||||||
|
|
||||||
Toujours en tant qu'utilisateur root:
|
|
||||||
```
|
|
||||||
cd /opt/scodoc/Products/ScoDoc/config
|
|
||||||
./install_debian10.sh
|
|
||||||
```
|
|
||||||
Répondez oui (Y) à toutes les questions, sauf, si vous avez une bonne raison de faire autrement.
|
|
||||||
En cas d'échec, ce script peut être relancé (il écrasera l'ancienne configuration).
|
|
||||||
|
|
||||||
Dans cette étape, sont installés et configurés automatiquement:
|
|
||||||
|
|
||||||
* serveur web Apache (et https)
|
|
||||||
* parefeu réseau (optionnel, basé sur `ufw`)
|
|
||||||
* messagerie pour envois messages (postfix) (optionnel mais très vivement recommandé)
|
|
||||||
* installation de divers logiciels utilisés par ScoDoc (par apt-get)
|
|
||||||
* script de lancement automatique de ScoDoc (service systemd).
|
|
||||||
|
|
||||||
(dans certains cas, l'installateur vous posera des questions sur votre configuration).
|
|
||||||
|
|
||||||
|
|
||||||
4. **Initialiser la base de données utilisateurs** (qui sera commune à tous les départements).
|
|
||||||
En tant que root:
|
|
||||||
```
|
|
||||||
cd /opt/scodoc/Products/ScoDoc/config
|
|
||||||
./create_user_db.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
5. **Mettre à jour le logiciel** (c'est absolument nécessaire, la version préinstallée étant incomplète):
|
|
||||||
En tant que root,
|
|
||||||
```
|
|
||||||
cd /opt/scodoc/Products/ScoDoc/config
|
|
||||||
./upgrade.sh
|
|
||||||
```
|
|
||||||
La première fois, il faudra accepter un certificat cryptographique, répondre "p (accept (p)ermanently)".
|
|
||||||
|
|
||||||
<img src="/img/alert.png" style="vertical-align: bottom; margin:0 0 0 0;" alt="/!\" /> Si un message d'erreur apparaît à la fin de la mise à jour, relancer `./upgrade.sh`.
|
|
||||||
|
|
||||||
|
|
||||||
Si vous migrez les données d'une installation existante, vous pouvez arrêter ici et appliquer la procédure [MigrationDonneesScoDoc](MigrationDonneesScoDoc.md)
|
|
||||||
|
|
||||||
6. **Initialiser la base de données pour un département** (vous pourrez à tout moment utiliser la même commande pour ajouter d'autres départements):
|
|
||||||
```
|
|
||||||
./create_dept.sh -n DEPT
|
|
||||||
```
|
|
||||||
Il faut alors saisir le nom abrégé du département: ce nom doit être un mot, sans ponctuation (GEII, RT, Info, ...). Il apparaîtra dans l'URL du site correspondant.
|
|
||||||
|
|
||||||
7. **Lancer ScoDoc**:
|
|
||||||
```
|
|
||||||
systemctl restart scodoc
|
|
||||||
```
|
|
||||||
et voila !
|
|
||||||
|
|
||||||
Visiter `https://votre.site.fr/` pour achever la configuration et utiliser le logiciel: voir la page [GuideConfig](GuideConfig.md)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## En cas de problème
|
|
||||||
Ne pas hésiter à me contacter ou à écrire sur la liste notes (voir [Listes de diffusion](ListesDeDiffusion.md)).
|
|
||||||
|
|
||||||
* Problèmes d'envoi de courrier électronique (mail): voir [ProblemesMail](ProblemesMail.md)
|
|
||||||
|
|
||||||
Nota: sur certains réseaux, l'autoconfiguration IPv6 pose problème (par exemple: bloquage des envois de mails). Au besoin, il est possible de désactiver IPv6 (voir par exemple [ici](https://wiki.debian-fr.xyz/D%C3%A9sactiver_l%27IPv6)).
|
|
||||||
|
|
||||||
|
|
||||||
## Ensuite...
|
|
||||||
* Appliquez fréquemment les [mises à jour](MisesAJour.md)
|
|
||||||
|
|
||||||
* Mettez en place des [sauvegardes](SauvegardesBases.md)
|
|
||||||
|
|
||||||
* Abonnez vous au moins à la liste d'annonces: voir [Listes de diffusion](ListesDeDiffusion.md)
|
|
||||||
@ -1,8 +0,0 @@
|
|||||||
# Guide d'installation sur Debian 9
|
|
||||||
|
|
||||||
Version ancienne de Debian, nous recommandons d'utiliser la nouvelle version.
|
|
||||||
Voir [installation sur Debian 10](GuideInstallDebianDix.md).
|
|
||||||
|
|
||||||
Si besoin, se reporter à [l'ancienne documentation pour Debian 9](https://trac.lipn.univ-paris13.fr/projects/scodoc/wiki/GuideInstallDebianNeuf).
|
|
||||||
|
|
||||||
|
|
||||||
@ -25,7 +25,7 @@ Le principe est donc:
|
|||||||
|
|
||||||
## Marche à suivre détaillée
|
## Marche à suivre détaillée
|
||||||
### Installation de Debian et ScoDoc
|
### Installation de Debian et ScoDoc
|
||||||
Voir les instructions ici: [GuideInstallDebianDix](GuideInstallDebianDix.md) (ou si votre système est encore en Debian 9: [GuideInstallDebianNeuf](GuideInstallDebianNeuf.md) : mais ce n'est pas conseillé)
|
Voir les instructions ici: [GuideInstallDebian11](GuideInstallDebian11.md).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -9,140 +9,3 @@ lancer une à tout moment avec la commande
|
|||||||
|
|
||||||
apt update && apt-get upgrade
|
apt update && apt-get upgrade
|
||||||
|
|
||||||
|
|
||||||
# Mises à jour de ScoDoc 7
|
|
||||||
**Les instructions ci-dessous concernent ScoDoc 7 uniquement.**
|
|
||||||
|
|
||||||
Le système Linux doit être correctement maintenu (en particulier, les mises à
|
|
||||||
jour de sécurité de Debian doivent être appliquées quotidiennement).
|
|
||||||
|
|
||||||
ScoDoc est actuellement prévu pour fonctionner avec Linux Debian 10.
|
|
||||||
|
|
||||||
* Les (rares) mises à jour majeures du logiciel ScoDoc sont annoncées sur la
|
|
||||||
liste
|
|
||||||
[scodoc-annonces](https://listes.univ-paris13.fr/mailman/listinfo/scodoc-annonces).
|
|
||||||
|
|
||||||
* Les (fréquentes) mises à jour mineures (corrections de bugs, améliorations)
|
|
||||||
sont annoncées sur la liste
|
|
||||||
[scodoc-devel](https://listes.univ-paris13.fr/mailman/listinfo/scodoc-devel).
|
|
||||||
|
|
||||||
|
|
||||||
*Une mise à jour hebdomadaire (au moins) est recommandée*
|
|
||||||
|
|
||||||
Pour appliquer une mise à jour de ScoDoc, se connecter en tant que `root` sur le
|
|
||||||
serveur, puis faire:
|
|
||||||
|
|
||||||
cd /opt/scodoc/Products/ScoDoc/config
|
|
||||||
./upgrade.sh
|
|
||||||
|
|
||||||
La première fois, il faudra accepter un certificat cryptographique, répondre "p
|
|
||||||
(accept (p)ermanently)".
|
|
||||||
|
|
||||||
<img src="/img/alert.png" style="vertical-align: bottom; margin:0 0 0 0;"
|
|
||||||
alt="/!\" /> Si un message d'erreur apparaît à la fin de la mise à jour,
|
|
||||||
relancer `./upgrade.sh`.
|
|
||||||
|
|
||||||
<img src="/img/alert.png" style="vertical-align: bottom; margin:0 0 0 0;"
|
|
||||||
alt="/!\" /> La mise à jour entraine une déconnexion des utilisateurs (mais pas
|
|
||||||
de pertes de données !).
|
|
||||||
|
|
||||||
Note: cette procédure ne change pas de version majeure de ScoDoc, ni du système
|
|
||||||
Linux. Pour cela, voir [MigrationDonneesScoDoc](MigrationDonneesScoDoc.md)) ou
|
|
||||||
plus bas sur cette page.
|
|
||||||
|
|
||||||
## Note concernant les anciens systèmes (Debian 9)
|
|
||||||
|
|
||||||
En Debian version 9 (et version antérieures), ScoDoc n'utilisait pas `systemd`
|
|
||||||
et n'était pas automatiquement relancé lors de mises à jour de certains
|
|
||||||
logiciels, comme la base de données `postgresql`. Sur ces systèmes, il est
|
|
||||||
conseillé de mettre à jour Debian avec le script
|
|
||||||
`/opt/scodoc/Products/ScoDoc/config/upgrade.sh` afin d'éviter d'interrompre le
|
|
||||||
service ScoDoc.
|
|
||||||
|
|
||||||
|
|
||||||
## Mise à jour rapide de Debian 9 à Debian 10 (obsolète)
|
|
||||||
|
|
||||||
Obsolète, sauf si vous avez encore un serveur avec Debian 9...
|
|
||||||
|
|
||||||
Procédure raccourcie réservée aux personnes à l'aise avec linux. On met à jour
|
|
||||||
Debian mais on réinstalle ScoDoc proprement.
|
|
||||||
|
|
||||||
Vérifiez que vous avez assez d'espace disque disponible (`df -h`, au moins 3Go
|
|
||||||
libres sur `/` ou `/opt`).
|
|
||||||
|
|
||||||
0. Sauvegardez complètement votre système en lieu sûr. Si la procédure
|
|
||||||
ci-dessous échoue, reprenez la voie normale:
|
|
||||||
[MigrationDonneesScoDoc](MigrationDonneesScoDoc.md).
|
|
||||||
|
|
||||||
1. Mettre à jour votre ScoDoc:
|
|
||||||
|
|
||||||
cd /opt/scodoc/Products/ScoDoc/config
|
|
||||||
./upgrade.sh
|
|
||||||
|
|
||||||
2. Arrêter le service (en Debian 9 on utilisait *SysV-style init*, à partir de
|
|
||||||
Debian 10 ScoDoc utilise `systemd`):
|
|
||||||
|
|
||||||
/etc/init.d/scodoc stop
|
|
||||||
|
|
||||||
|
|
||||||
3. Sauvegarder les données et configurations ScoDoc:
|
|
||||||
|
|
||||||
cd /opt/scodoc/Products/ScoDoc/config
|
|
||||||
./save_scodoc_data.sh /opt/data-scodoc-deb9 # par exemple
|
|
||||||
|
|
||||||
|
|
||||||
4. Mettre à jour Debian: pour les détails voir
|
|
||||||
[https://www.debian.org/releases/stable/amd64/release-notes/ch-upgrading.html](https://www.debian.org/releases/stable/amd64/release-notes/ch-upgrading.html).
|
|
||||||
|
|
||||||
|
|
||||||
En résumé:
|
|
||||||
|
|
||||||
- éditer `/etc/apt/sources.list` et indiquer
|
|
||||||
```
|
|
||||||
deb http://deb.debian.org/debian buster main contrib
|
|
||||||
```
|
|
||||||
|
|
||||||
- puis:
|
|
||||||
```
|
|
||||||
apt-get remove firehol
|
|
||||||
apt update
|
|
||||||
apt-get upgrade
|
|
||||||
apt full-upgrade
|
|
||||||
apt autoremove
|
|
||||||
```
|
|
||||||
et **rebooter**.
|
|
||||||
|
|
||||||
|
|
||||||
5. Supprimer postgresql 9.6
|
|
||||||
|
|
||||||
On enlève carrément l'ancien, le script d'installation de ScoDoc installera la
|
|
||||||
version 11:
|
|
||||||
|
|
||||||
apt-get --purge remove postgresql
|
|
||||||
|
|
||||||
|
|
||||||
6. Réinstaller ScoDoc
|
|
||||||
|
|
||||||
Déplacer l'ancienne installation de ScoDoc (vous la supprimerez plus tard):
|
|
||||||
|
|
||||||
mv /opt/scodoc /opt/scodoc.deb9
|
|
||||||
|
|
||||||
|
|
||||||
Réinstaller un ScoDoc tout neuf, en suivant [GuideInstallDebianDix](GuideInstallDebianDix.md)
|
|
||||||
|
|
||||||
La plupart des composants de votre système seront déjà présents, donc répondre en général "non" aux questions du script d'installation.
|
|
||||||
|
|
||||||
S'arrêter avant l'initialisation des bases de données.
|
|
||||||
|
|
||||||
7. Restaurer la sauvegarde:
|
|
||||||
|
|
||||||
cd /opt/scodoc/Products/ScoDoc/config
|
|
||||||
./restore_scodoc_data.sh /opt/data-scodoc-deb9
|
|
||||||
|
|
||||||
Vérifiez et voilà.
|
|
||||||
|
|
||||||
- Faire un peu de ménage (supprimer `/opt/scodoc.deb9` quand vous êtes sûr de n'y avoir rien oublié), vérifiez les logs (`/opt/scodoc/log`).
|
|
||||||
|
|
||||||
- Vérifier que le nouveau système (et ses bases de données) est bien sauvegardé ([SauvegardesBases](SauvegardesBases.md)).
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -94,10 +94,17 @@ Les prochaines versions de ScoDoc (*sous réserve !*):
|
|||||||
- calcul des moyennes d'UE
|
- calcul des moyennes d'UE
|
||||||
- bulletin de note v1
|
- bulletin de note v1
|
||||||
|
|
||||||
- ScoDoc 9.2 : fin 2021 ou début 2022 nouvelles fonctionnalités liées au BUT
|
- ScoDoc 9.2 : mars 2022 nouvelles fonctionnalités liées au BUT
|
||||||
- tenue des jurys de S1
|
- référentiels de compétences Orébut
|
||||||
|
- capitalisation des UE dans le BUT
|
||||||
|
- bonus/malus locaux
|
||||||
|
- bulletins BUT pdf
|
||||||
|
- nouveau module de gestion relations avec les entreprises
|
||||||
|
|
||||||
|
- ScoDoc 9.3 : mai 2022
|
||||||
|
- tenue des jurys BUT et exports Apogée
|
||||||
- gestion des parcours (pour la mise en place des semestre)
|
- gestion des parcours (pour la mise en place des semestre)
|
||||||
- import Orébut avec gestion adaptation locale (à l'étude)
|
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user