DocScoDoc/docs/GuideConfig.md

141 lines
4.5 KiB
Markdown
Raw Normal View History

2020-09-21 16:30:27 +02:00
# Prise en main et paramétrage de ScoDoc 9
2020-09-21 16:30:27 +02:00
<img src="/img/alert.png" style="vertical-align: bottom; margin:0 0 0 0;" alt="/!\" /> Cette
page concerne la version ScoDoc 9, distribuée à partir de septembre 2021. Pour l'ancienne
version, voir [cette page](GuideConfig7.md).
2020-09-21 16:30:27 +02:00
Ce document suppose que le logiciel a été installé suivant la procédure décrite dans
[GuideInstallDebian11](GuideInstallDebian11.md).
2020-09-21 16:30:27 +02:00
# Administration en ligne de commande
Les opérations d'administration se résument à la création de départements, et l'installation
des logos, et la 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, 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
ssh), en tant qu'utilisateur `scodoc` (et non `root`).
Se connecter et initialiser la session ainsi:
ssh votre.serveur # si nécessaire
su scodoc # idem,
# ou tout autre moyen d'ouvrir un shell comme scodoc
cd /opt/scodoc
source venv/bin/activate
Après quoi, vous pouvez utiliser les commandes décrites ci-dessous.
## Création d'un département
flask create-dept DEPT
`DEPT` est l'acronyme du département, par exemple "RT". Ce département
apparait immédiatement sur la page d'accueil.
## Suppression d'un département
Opération très rarement nécessaire, proposée pour corriger une erreur
immédiatement après la création.
flask delete-dept DEPT
## Création d'un utilisateur
Cette opération s'effectue en général depuyis le logiciel, via un formulaire
ou un import excel. Depuis la consoile, faire:
flask user-create LOGIN ROLE DEPT
`LOGIN` sera le pseudo de l'utilisateur (utilisé pour se connecter),
et `ROLE` le rôle (`Ens`, `Secr`, `Admin`) dans le département `DEPT`.
## Création d'un super-administrateur
Il s'agit d'un utilisateur ayant tous les droits, comme s'il était
`Admin` dans tous les départements.
flask user-create admin2 SuperAdmin @all
2020-09-21 16:30:27 +02:00
`admin2` est ici le pseudo du nouvel admin.
2020-09-21 16:30:27 +02:00
## Changement du mot de passe d'un utilisateur
Cette opération peut s'effectuer via la page de gestion web des
utilisateurs, mais il est parfois commode de le faire depuis la
console:
2020-09-21 16:30:27 +02:00
flask user-password LOGIN
2020-09-21 16:30:27 +02:00
`LOGIN` est le pseudo de l'utilisateur. Le mot de passe est demandé
sur la ligne de commande.
2020-09-21 16:30:27 +02:00
## Migration des données de ScoDoc 7
Les données dans ScoDoc 9 ayant un format et une organisation très différents
de ScoDoc 7, une étape de conversion (migration) est nécessaire. Elle est automatique
mais prends du temps.
2020-09-21 16:30:27 +02:00
**XXX la procédure de migration "en place" n'est pas encore disponible.**
2020-09-21 16:30:27 +02:00
**Un script inétgré réalise les deux étapes suivantes, la doc arrive XXX**
2020-09-21 16:30:27 +02:00
### Comptes utilisateurs
2020-09-21 16:30:27 +02:00
Toujours migrer les comptes utilisateurs avant d'importer les
départements.
2020-09-21 16:30:27 +02:00
flask import-scodoc7-users
2020-09-21 16:30:27 +02:00
### Départements
Pour migrer un seul département:
flask import-scodoc7-dept DEPT DBNAME
Exemple:
flask import-scodoc7-dept InfoComm DBINFOCOMM
2020-09-21 16:30:27 +02:00
## Changement des logos apparaissant sur les documents
*Note: après migration, vos logos de ScoDoc 7 sont installés dans ScoDoc 9*.
Les documents PDF (PV de jurys...) incluent les logos de l'établissement.
Par défaut, ceux de l'IUT de Villetaneuse et de l'Université Paris 13 sont
distribués. Pour les changer, placer vos logos (fichiers images JPEG ou PNG)
dans le répertoire
/opt/scodoc-data/config/logos
avec les noms `logo_header.jpg` (habituellement le logo de votre composante)
et `logo_footer.jpg` (habituellement le logo de votre université ou école).
2020-09-21 16:30:27 +02:00
Ensuite, éditez le fichier
/opt/scodoc-data/config/logos
et changer les valeurs des variables `CONFIG.LOGO_FOOTER_ASPECT` et suivantes
(ce n'est pas pratique, il faudrait modifier le code ScoDoc pour calculer ces valeurs
à partir des fichiers images).
Enfin, redémarrez ScoDoc après avoir vidé les caches:
flask clear-cache
systemctl restart scodoc9
# Utilisation via le Web
* Connectez-vous au site: `https://votre.site.fr/`
2020-09-21 16:30:27 +02:00
Vous allez voir la page d'accueil de ScoDoc, vous permettant de choisir le département
où travailler.
2020-09-21 16:30:27 +02:00
<img src="/img/alert.png" style="vertical-align: bottom; margin:0 0 0 0;" alt="/!\" /> Surtout,
évitez de travailler comme "admin" (super admin): prenez le temps de créer un utilisateur
"chef de département !" dans chaque département, qui à son tour pour déléguer des droits.