iziram/DocAssiduites
1
0
Fork 0
forked from ScoDoc/DocScoDoc
Code Issues Pull Requests Packages Projects Releases Wiki Activity

- Documentattion du CAS;

Browse Source 
- Remise en forme de plusieurs pages.
This commit is contained in:
Emmanuel Viennet 2023-03-01 19:05:21 +01:00
parent c5daabd018
commit 4948da5e84
27 changed files with 626 additions and 324 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

127
docs/AdminUsers.md
View File

@ -1,56 +1,52 @@
# Gestion des utilisateurs dans ScoDoc
## Gestion des utilisateurs dans ScoDoc
ScoDoc gère sa liste d'utilisateurs (enseignants, secrétaires) dans
une base de données SQL.
ScoDoc gère sa propre base d'utilisateurs (enseignants, administratifs,
secrétaires). Rappelons que les étudiants ne sont pas des utilisateurs, ils
n'ont pas d'accès direct au logiciel.
### Principes généraux
## Principes généraux
Depuis ScoDoc 9.0, la liste des utilisateurs est enregistrée dans la base de
données unique SCODOC (en production) (voir la partie implémentation pour plus
de détails).
Les utilisateurs sont associés à:
Les entités gérées par scodoc sont :
- Les utilisateurs ;
- les rôles ;
- en liaison avec les départements.
- un identifiant unique (`user_name`), propre à ScoDoc;
- une adresse email;
- un ensemble de rôles;
- un département ScoDoc de rattachement (optionnel);
- un statut actif/inactif.
- d'autres attributs, comme l'identifiant CAS (voir [Configuration du CAS](ConfigCAS.md))
#### L'entité utilisateur
- possède les propriétés habituelles (nom, prénom, user_name, email);
- peut être associé à un département ou pas (cas d'un administrateur gérant
plusieurs départements);
- assure un ou plusieurs rôles.
### Rôles et permissions
#### L'entité rôle
Un rôle est le regroupement d'un certain nombre de privilèges.
C'est généralement la combinaison d'un département et d'un type d'utilisation.
Actuellement au nombre de quatre (d'autres sont prévus, notamment pour le module
relations entreprises) :
- Administrateur
- Secrétariat
- Enseignant
- Observateur
Les rôles sont eux-même associés à des permissions: on donne une permission (ex:
"enregistrer des absences") à un ou plusieurs rôles, et on associe chaque compte
utilisateur à un ou plusieurs rôles. Ce système est à la fois flexible et facile
à configurer. Plus de détails [sur la page dédiée](ConfigPermissionsDept.md).
Par ailleurs, le contexte d'utilisation donne certains privilèges (par exemple
la faculté de saisir des notes, de justifier des absences, de modifier la
définition des programmes, ...).
Un rôle permet de grouper un ensemble de permissions nécessaire pour remplir des
tâches données (secrétariat, responsable de formation, intervenant enseignant,
...).
_Exemple:_
Un utilisateur peut être associé à un nombre quelconque de rôle, chaque
association étant valable pour un département donné (ou bien éventuellement
tous). Il peut ainsi être "Responsable" dans un département et "Enseignant" dans
un autre.
L'utilisateur 'Dupont' est responsable ScoDoc pour son département *RT* mais
intervient également en enseignement au département *GEII*.
On pourra lui attribuer les rôles `AdminRT` et `EnsGEII`, ce qui lui permettra :
### Département de rattachement
- de gérer les utilisateurs du (seul) département RT :
Privilèges associés : `Gérer les utlisateurs (Sco Users Manage)`, `Changer les
formations (Sco Change Formation)`, ...
- d'accéder aux vues enseignant pour le département GEII :
Privilèges associés : `Voir les parties pour les enseignants (Sco View Ens)`,
`Saisir des absences (Sco Change Absences)`, ...
Le département de rattachement est utilisé pour afficher rapidement la liste des
comptes d'un département (accès par un responsable de formation, chef de
département, ...). Certains comptes ne sont pas rattachés à un département
(administrateurs).
Pour une description plus fine des privilèges, voir
[ConfigPermissions](ConfigPermissions.md)
### Fermeture des comptes
### Opérations et cycle de vie des utilisateurs
En principe, on ne **supprime** pas de compte utilisateur s'ils ont déjà été
utilisés. En effet, afin de permettre la traçabilité des opérations, ScoDoc
conserve des références aux utilisateurs. Pour fermer un compte, on le rend
**inactif**. Un utilisateur inactif ne peut plus se connecter, et n'apparait pas
dans les listes par défaut.
## Opérations et cycle de vie des utilisateurs
Un compte utilisateur peut être modifié par 3 types d'utilisateurs :
@ -60,11 +56,11 @@ Un compte utilisateur peut être modifié par 3 types d'utilisateurs :
Les opérations existantes sont :
- La création ;
- La création;
- la demande de renouvellement de mot de passe;
- la désactivation.
#### Notes:
### Notes
- La suppression d'un utilisateur est impossible (nécessité de garder la trace
des anciens historiques), mais on peut le rendre inactif (il n'apparait alors
@ -73,10 +69,11 @@ Les opérations existantes sont :
mot de passe par mail) a été remplacé par l'ajout de la mention suivante dans
le formulaire de connexion :
```text
En cas d'oubli de votre mot de passe cliquez ici pour le réinitialiser.
```
` En cas d'oubli de votre mot de passe cliquez ici pour le réinitialiser. `
#### Création d'un utilisateur (par formulaire)
### Création d'un utilisateur (par formulaire)
La création d'un utilisateur peut être faite par un administrateur ou super
administrateur. Le lien `Ajouter un utlisateur` permettant cela se trouve dans
@ -100,20 +97,18 @@ scenarii suivants :
Une case à cocher `envoyer un mail d'accueil à l'utlisateur` permet de choisir
la troisième option (si décochée), sinon la case suivante `indiquer par mail de
changer le mot de passe initial` permet de choisir entre l'option 1 et l'option
2.
Dans tous les cas les mails seront envoyés avec l'adresse de réponse précisée par la valeur de la variable d'environnement
`SCODOC_MAIL_FROM` (par défaut `no-reply@{serveur_mail}`). Cette variable peut être initialisée dans le fichier .env par exemple avec la ligne:
```bash
SCODOC_MAIL_FROM=no-reply@univ-exemple.fr
```
Dans tous les cas les mails seront envoyés avec l'adresse de réponse précisée
par la valeur de la variable de configuration `email_from_addr`, qui peut être
spécifié au niveau général ou département par département (voir
[Configuration des envois d'emails](ConfigEmail.md))
**Le département d'appartenance** peut être choisi si le créateur est
administrateur pour plusieurs départements. Il aura alors le loisir
de sélectionner l'un des départements qu'il administre (liste déroulante).
#### Création en masse (fichier xlsx)
### Création en masse (fichier xlsx)
Le super-administrateur (et lui seulement) peut également créer des comptes en
masse par téléversement d'un fichier au format `.xlsx` par le biais du lien
@ -130,17 +125,18 @@ Les colonnes à remplir sont les suivantes :
- `email`: l'email de l'utilisateur ; (obligatoire, unique dans scodoc)
- `roles`: le ou les rôles attribués à l'utilisateur séparés par des virgules (exemple `Admin_RT, Ens_GEII`)
- `dept`: le département de rattachement de l'utilisateur (acronyme, en lettres capitales).
- `cas_id`, ...: optionnel, voir [Configuration du CAS](ConfigCAS.md)
_Note_:
- Tous les utilisateurs sont créés ou bien aucun.
- Un mail est envoyé à chaque utilisateur nouvellement créé.
#### Changement du mot de passe
### Changement du mot de passe
Deux circonstances sont envisagées.
##### Oubli de mot de passe
#### Oubli de mot de passe
Lorsqu'un utilisateur a perdu son mot de passe, il a la possibilité de retrouver
son accès sans intervention d'un administrateur. Il lui suffit de demander la
@ -149,15 +145,15 @@ de son email (qui est maintenant identifiant dans scodoc), un mail lui est
envoyé. ce mail contient un lien comportant un jeton à durée limitée. Ce lien
renvoie vers la page permettant de redéfinir le mot de passe de l'utilisateur.
##### Edition du profil
#### Édition du profil
Si l'utilisateur peut se connecter, il peut éditer son profil (et par là,
modifier son email et/ou son mot de passe). La barre latérale de l'écran
principal de scodoc affiche dans le coin supérieur gauche la version courante de
scodoc ainsi que l'identification de l'utilisateur actuel. Un clic sur le nom
permet à l'utilsateur d'éditer son profil.
permet à l'utilisateur d'éditer son profil.
#### Activation/désactivation
### Activation/désactivation
Une fois créé, le compte utilisateur conserve son existence. Il peut cependant être rendu inactif:
@ -169,7 +165,7 @@ n'est donc pas possible de créer un nouveau compte associé au même email). Il
est simplement impossible de se connecter ou de modifier le profil de ce compte
par l'utilisateur lui-même.
### Implémentation (pour les développeurs)
## Implémentation (pour les développeurs)
Le graphe d'état ci-dessous explicite les différents états que peux prendre un
compte utilisateur en fonction des opérations qu'il subit.
@ -183,7 +179,6 @@ On notera:
3. Que les états `créé`et `créé + ticket`permettent la connexion (sous réserve
de la connaissance du mot de passe).
<img src="/fig/GrapheUser.png" />
**SCODOC**.
@ -209,11 +204,17 @@ La table **user** contient:
|token | text | dernier token émis (changement de mot de passe) | 1a, 3 |
|token_expiration | timestamp without time zone | date d'expiration du dernier token émis | 1a, 3 |
(les champs utilisé pour le CAS ne sont pas mentionnés ici)
<img src="/img/alert.png" style="vertical-align: bottom; margin:0 0 0 0;"
alt="/!\" /> encodage `utf-8`, sauf si vous avez modifié l'installation.
🚸 encodage `utf-8`, sauf si vous avez modifié l'installation.
Pour la signification des rôles et l'utilisation du département, voir
[ConfigPermissions](ConfigPermissions.md).
!!! note "Voir aussi"
- [Configuration du CAS](ConfigCAS.md)
- [Guide administrateur ScoDoc](GuideAdminSys.md)
- [Configuration des envois d'emails](ConfigEmail.md)
- [FAQ](FAQ.md)
- [Contacts](Contact.md).

33
docs/ApiCreationParcours.md
View File

@ -1,21 +1,32 @@
# Cursus ScoDoc
# Parcours ScoDoc
Les cursus pédagogiques sont définis dans ScoDoc par des classes de "parcours" qui définissent les paramètres: nombre de semestres, modalités de validation des UE, etc.
Les cursus pédagogiques sont définis dans ScoDoc par des classes de "cursus" qui
définissent les paramètres: nombre de semestres, modalités de validation des UE,
etc.
Plusieurs parcours sont définis dans ScoDoc, l'utilisateur choisi l'un d'entre eux pour chacun des programmes pédagogique (menu **Type de parcours**).
Les parcours existants incluent les suivants:
Plusieurs cursus sont définis dans ScoDoc, l'utilisateur choisi l'un d'entre eux
pour chacun des programmes pédagogique (menu **Type de parcours**). Les cursus
existants incluent les suivants:
* DUT (*Diplôme Universitaire de Technologie*, en quatre semestres)
* Licence Professionnelle
* Master (différents types)
* etc.
* BUT (*Bachelor Universitaire de Technologie*, usuellement en 6 semestres)
* DUT (*Diplôme Universitaire de Technologie*, en quatre semestres)
* Licence Professionnelle
* Licence
* Master (différents types)
* etc.
Il est possible d'ajouter des parcours adaptés en ajoutant du code Python. Toutefois, afin de ne pas perturber les mises à jours et de garantir la pérennité des modifications, il est très recommandé de partager les modifications pour inclusion dans le code ScoDoc. Contacter pour cela la liste scodoc-devel ([listes de diffusion](ListesDeDiffusion.md)).
Il est possible d'ajouter des cursus adaptés en ajoutant du code Python.
Toutefois, afin de ne pas perturber les mises à jours et de garantir la
pérennité des modifications, il est très recommandé de partager les
modifications pour inclusion dans le code ScoDoc. Contacter pour cela les
développeurs ([Contacts](Contact.md)).
## Quelques indications pour les programmeurs
## Quelques indications pour les programmeurs
Les parcours sont définis dans le module `sco_codes_parcours.py`. Chaque parcours correspond à une sous-classe de `TypeParcours`, définissant des paramètres et quelques méthodes.
Les parcours sont définis dans le module `codes_cursus.py`. Chaque parcours
correspond à une sous-classe de `TypeCursus`, définissant des paramètres et
quelques méthodes.
Les paramètres (déclarés comme des variables de classe) sont les suivants:

5
docs/BUT.md
View File

@ -10,6 +10,11 @@ gérer avec ScoDoc. Pour les curieux, la page
[modélisation des parcours BUT](ModelisationParcoursBUT.md)
donne quelques détails sur la façon dont ScoDoc organise les objets du BUT.
De nombreux aspects sont aussi décrits dans les
<a
href="https://www.youtube.com/playlist?list=PLw49h6RbvswhasBk9bXj7PzOD8GDW3kG1"
target="_blank">Tutoriels sur YouTube <img src="/img/tube.png" alt=""
style="margin-top:0px; margin-bottom:0px; border-width:0px;"/></a>
## UE, modules, évaluations

103
docs/ConfigCAS.md Normal file
View File

@ -0,0 +1,103 @@
# Configuration de l'authentification CAS
*Cette page s'adresse aux administrateurs système en charge de ScoDoc.*
Le CAS, *Central Authentication Service* CAS est un système d'authentification
unique (SSO) très utilisé dans les universités. Il permet à l'utilisateur de
s'identifier sur un site unique (souvent appelé "ENT" en raccourci), pour
ensuite accéder aux différents services. Il évite de s'authentifier à
chaque fois qu'on accède à une application en mettant en place un système de
ticket.
Notons que le CAS peut introduire des faiblesses dans l'application:
- indisponibilité ou lenteur du service;
- vulnérabilité si le serveur CAS (ou l'annuaire sur lequel il s'appuie) venait
à être piraté.
Il est donc conseillé de s'assurer du bon fonctionnement et de la sécurisation de
son service CAS avant d'aller plus loin.
## Comptes utilisateurs ScoDoc et CAS
Rappel: voir [Gestion des utilisateurs](AdminUsers.md)
Pour simplifier, l'utilisateur va partir de ScoDoc, passer par le site CAS (redirection), puis
revenir si l'authentification réussi, avec un jeton et un identifiant CAS. À ce moment, ScoDoc cherche s'il a un
utilisateur ayant l'identifiant donné, dans le champ `cas_id`de sa base
utilisateur. Si oui, il ouvre une session pour cet utilisateur, avec ses rôles
et permissions.
## Paramètres spécifiques pour le CAS
### Configuration générale
Les pages de configuration générale de ScoDoc sont accessibles via la page
d'accueil, uniquement lorsqu'on est connecté comme super-admin.
![accès au panneau de config](fig/config-accueil.png)
De cette page, on accède à la page consacrée au CAS:
![config du CAS](fig/config-cas.png)
Page sur laquelle on va pouvoir spécifier:
- si on active le CAS (ce qui permet aussi de le désactiver globalement);
- si on force son utilisation;
- l'URL complète du serveur CAS (exemple: `https://mon.serveur.cas.fr:1234/cas/`);
- un attribut pour l'identification (laisser vide normalement);
- si on veut vérifier le certificat SSL (normalement oui, par sécurité, et
fournir le fichier certificat PEM dans le champ suivant).
Si l'option **Forcer l'utilisation du CAS** est activée, l'utilisateur qui tente
de se connecter sera immédiatement redirigé vers la page du CAS. Sinon, il aura
le choix via le formulaire classique, avec un lien en plus:
![login scodoc avec CAS](fig/config-cas-cnx.png)
🚸 Attention, le lien de réinitialisation du mot de passe ne concerne évidemment
pas le mot de passe du CAS, mais celui de ScoDoc. C'est ennuyeux.
À ce stade, CAS est utilisable, mais on n'a aucun utilisateur reconnu !
### Configuration des utilisateurs
ScoDoc doit connaitre l'identifiant CAS de ses utilisateurs. A défaut d'un
annuaire, il va falloir saisir ces identifiants pour chaque compte. On peut le
faire via le formulaire habituel de paramétrage du compte utilisateur, ou bien
par import Excel.
Le formulaire n'est accessible qu'au super-admin (actuellement).
![form. config. utilisateur](fig/config-cas-user.png)
Ici trois champs nous intéressent:
- **Identifiant CAS**: nécessaire
- **Autorise connexion via CAS**: spécifie si ce compte peut ou non se connecter via CAS.
- **Autorise connexion via ScoDoc**: spécifie si cet utilisateur peut se connecter via
ScoDoc, sans CAS, lorsque le CAS est activé et forcé. Ceci est nécessaire par
exemple pour des comptes utilisés pour l'API, ou bien pour des personnes
extérieures à l'établissement et qui ne seraient pas (encore) dans le CAS.
En cas de besoin, les comptes "super-admin" peuvent toujours se connecter à ScoDoc sans CAS: si le
forçage est activé, il leur faut passer par une adresse spéciale:
```text
https://votre.serveur.scodoc.fr/auth/login_scodoc
```
🚸 **Attention**: en général, les **clients d'API** (et notamment la
"passerelle") n'utilisent pas le CAS: si vous forcez les utilisateurs à utiliser
le CAS, pensez à autoriser les comptes de l'API à se connecter sur ScoDoc sans
CAS.
!!! note "Voir aussi"
- [Gestion des utilisateurs](AdminUsers.md)
- [Guide administrateur ScoDoc](GuideAdminSys.md)
- [API pour ScoDoc 9](ScoDoc9API.md)
- [FAQ](FAQ.md)
- [Contacts](Contact.md).

10
docs/ConfigEmail.md
View File

@ -12,7 +12,8 @@ Il est donc important de bien configurer le système de messagerie du serveur
ScoDoc. Ce point ne peut pas être documenté ici, car il dépend de
l'environnement local: relais de messagerie, politiques de filtrage, etc.
Par défaut, ScoDoc utilise le service SMTP Postfix, qui doit donc être configuré
pour relayer les messages vers la passerelles de l'établissement.
pour relayer les messages vers la passerelle de l'établissement: voir la page
[envoi des courriers électroniques](ProblemesMail.md).
Une fois cela fait, l'utilisateur (administrateur) de ScoDoc a peu de réglages a
effectuer.
@ -32,3 +33,10 @@ Ce réglage peut être modifié au niveau de chaque département, via la page
Les notifications liées à l'absentéisme (fréquences, contenu) peuvent être
réglées via via la page **Paramétrage** de chaque département:
![Réglage des notifications](fig/config-dept-abs.png)
!!! note "Voir aussi"
- Configuration système: [Envoi des courriers électroniques](ProblemesMail.md)
- Installation, flux réseaux et configuration: [Guide d'installation](GuideInstallDebian11.md)
- [Contacts](Contact.md)

6
docs/ConfigPermissions.md
View File

@ -1,12 +1,16 @@
# Rôles définis dans l'installation standard
🚧 *cette page est ancienne et à revoir*.
Voir aussi sur les rôles et leur utilisation la page [ConfigPermissionsDept](ConfigPermissionsDept.md)
Les informations ci-dessous ne sont utiles que pour les développeurs ou pour des usages avancés de ScoDoc.
## Principales permissions et fonctions associées
### Liste des permissions Zope
Les permissions utilisées par ScoDoc ont des noms qui commencent par "Sco", de façon à les grouper dans l'interface de Zope (ZMI), qui est peu pratique.
Pour changer ces permissions (plus précisément pour associer les permissions à des rôles), aller dans l'onglet "Security" du dossier "Dept" (celui qui *contient* l'instance de ScoDoc, habituellement nommée "Scolarite").

60
docs/ConfigPermissionsDept.md
View File

@ -1,13 +1,44 @@
# Rôles et permissions dans ScoDoc
## Rôles définis dans l'installation standard
ScoDoc défini par défaut quatre rôles principaux (d'autres sont prévus, notamment pour le module
relations entreprises):
- Administrateur
- Secrétariat
- Enseignant
- Observateur
Par ailleurs, le contexte d'utilisation donne certains privilèges (par exemple
la faculté de saisir des notes, de justifier des absences, de modifier la
définition des programmes, ...).
## Exemple
L'utilisateur 'Dupont' est responsable ScoDoc pour son département *RT* mais
intervient également en enseignement au département *GEII*.
On pourra lui attribuer les rôles `AdminRT` et `EnsGEII`, ce qui lui permettra :
- de gérer les utilisateurs du (seul) département RT :
Privilèges associés : `Gérer les utlisateurs (Sco Users Manage)`, `Changer les
formations (Sco Change Formation)`, ...
- d'accéder aux vues enseignant pour le département GEII :
Privilèges associés : `Voir les parties pour les enseignants (Sco View Ens)`,
`Saisir des absences (Sco Change Absences)`, ...
Pour une description plus fine des permissions, voir
[ConfigPermissions](ConfigPermissions.md).
## Rôles définis dans l'installation standard
`XXX` désigne typiquement le nom du département ("RT" ou "GEA").
* `AdminXXX`: toutes opérations ScoDoc (chef de département, et éventuellement un ou deux collaborateurs de confiance);
* `AdminXXX`: toutes opérations ScoDoc (chef de département, et éventuellement un ou deux collaborateurs de confiance);
* `EnsXXX`: enseignant du département;
* `EnsXXX`: enseignant du département;
* `SecrXXX`: secrétaire du département.
* `SecrXXX`: secrétaire du département.
L'installation standard défini aussi un utilisateur "*admin*", qui a le rôle "Manager", ce qui lui confère normalement tous les droits sur toutes les parties du site. L'usage de cet utilisateur particulier devrait être réduit à la création de nouveaux départements, et son mot de passe ne devrait pas être divulgué aux utilisateurs de ScoDoc.
@ -19,18 +50,23 @@ Le département de rattachement est utile pour indiquer qui (quel administrateur
Le fait d'être, ou non, associé à un département est important pour les responsables (rôle `AdminXXX`. En effet, si le responsable est associé à un département, il ne pourra créer des utilisateurs que dans ce département (c'est en général ce qu'on veut pour un chef de département, qui "recrute" des enseignant uniquement dans son département).
## Permissions dépendantes du contexte
## Permissions dépendantes du contexte
Outre les rôles associés à chaque utilisateur, le calcul des autorisations dépend du contexte de l'opération. Par exemple, un responsable de semestre a des droits particulier sur ce semestre, ou encore un responsable de module sur la saisie des notes dans ce module.
### Qui peut saisir des notes ?
Peuvent saisir des notes dans une évaluation située dans un module:
* le ou les administrateurs (rôle `AdminXXX`, où `XXX` est le département);
* le responsable du semestre (directeur des études);
* le responsable du module;
* les enseignants "associés" au module (en général des collègues désignés par le responsable de module ou le directeur des études).
* le ou les administrateurs (rôle `AdminXXX`, où `XXX` est le département);
* le responsable du semestre (directeur des études);
* le responsable du module;
* les enseignants "associés" au module (en général des collègues désignés par le responsable de module ou le directeur des études).
----
Voir aussi la page [ConfigPermissions](ConfigPermissions.md) pour plus de détails sur les permissions (pour les développeurs).
!!! note "Voir aussi"
- [ConfigPermissions](ConfigPermissions.md) pour plus de détails sur les permissions (pour les développeurs)
- [Gestion des utilisateurs](AdminUsers.md)
- [Guide administrateur ScoDoc](GuideAdminSys.md)
- [FAQ](FAQ.md)
- [Contacts](Contact.md).

51
docs/Contact.md Normal file
View File

@ -0,0 +1,51 @@
# Contacter le projet ScoDoc
La plate-forme Discord est le principal canal de communication entre les
utilisateurs et entre les développeurs:
[rejoindre le discord ScoDoc Assistance](https://discord.gg/ybw6ugtFsZ)
Il existe aussi un autre salon Discord réservé aux développeurs, n'hésitez pas à
demander à le rejoindre.
## Liste de diffusion
* [scodoc-annonces](https://listes.univ-paris13.fr/mailman/listinfo/scodoc-annonces) liste à très faible trafic, en lecture seule, seules des annonces importantes sont postées (quelques messages par an), tous les utilisateurs sont encouragés à s'y abonner. Indispensable aux administrateurs du logiciel.
## Signaler un problème (bug logiciel)
Tous les utilisateurs sont encouragés à signaler les erreurs qu'ils rencontrent,
afin qu'elles soient rapidement corrigées.
Pour cela, il existe un canal dédié sur le Discord: [🐞 bugs](https://discord.gg/BvAFnZU6UA)
Pour signaler un bug, il faut donner le maximum d'informations pour que nous
puissions le reproduire. Le mieux est d'envoyer les données d'assistance (lien
en bas de la page d'accueil du département) et d'indiquer quelle page ou
étudiant ou opération pose problème. Les données d'assistance ne contiennent pas
les noms, adresses et autres données personnelles: il faut donc indiquer
l'adresse de la page et jamais le nom d'un étudiant. Par exemple
`QLIO/Scolarite/Notes/formsemestre_bulletinetud?formsemestre_id=123&etudid=123456`
permet d'indiquer le semestre et l'étudiant à regarder.
![Envoi des données d'assistance](fig/envoi-assistance.png)
## Développeurs
Vous trouverez les sources du projet, les tickets (*issues*) et autres outils sur
* [gitea](https://scodoc.org/git/)
Vous pouvez demander un compte sur cette plate-forme pour ajouter des tickets,
proposer votre code (*pull requests*).
(Nous avons choisi le logiciel libre [Gitea](https://gitea.io) et non GitHub
afin de ne pas dépendre d'une plate-forme commerciale et de garder un contrôle
complet sur nos travaux).
## Anciennes listes de diffusion
Ces listes ne sont plus utilisées, remplacées par le Discord.
* [Notes](https://listes.univ-paris13.fr/mailman/listinfo/notes) discussions ou questions liées à l'utilisation du logiciel, entraide entre utilisateurs: vous pouvez y intervenir librement (les messages sont modérés pour éviter le spam).
* [scodoc-devel](https://listes.univ-paris13.fr/mailman/listinfo/scodoc-devel) échanges entre développeurs. Abonnez-vous si vous êtes intéressés par le développement du logiciel, souhaitez participer ou poser des questions techniques.

29
docs/Contribuer.md
View File

@ -1,30 +1,29 @@
# Contribuer à ScoDoc
ScoDoc est un logiciel libre, et repose sur des volontaires comme vous. Chacun
peut aider, en améliorant la documentation (page, vidéos), en s'abonnant à la
liste Notes (voir [listes de diffusion](ListesDeDiffusion.md)) pour y aider les
peut aider, en améliorant la documentation (page, vidéos), en rejoignant le
serveur Discord (voir [contacts](Contact.md)) pour y aider les
collègues, ou en développant ou testant le logiciel.
Les canaux de communication entre développeurs sont d'une part la liste de
diffusion mail [scodoc-devel](ListesDeDiffusion.md), d'autre part un serveur
Discord (accès sur invitation, demander par mail). Vous pourrez demander un
compte sur le [git du projet](https://scodoc.org/git), consulter/ajouter des
tickets, proposer votre code (*pull requests*).
Les canaux de communication entre développeurs sont [indiqués sur cette
page](Contact.md). Vous pouvez demander un compte sur le [git du
projet](https://scodoc.org/git), consulter/ajouter des tickets, proposer votre
code (*pull requests*).
## Contribuer à la documentation
La documentation est constituée de deux parties:
- les vidéos postées sur [la chaîne
YouTube](https://www.youtube.com/playlist?list=PLw49h6RbvswhasBk9bXj7PzOD8GDW3kG1).
Proposez de nouvelles vidéos, c'est très facile à faire !
- les vidéos postées sur [la chaîne
YouTube](https://www.youtube.com/playlist?list=PLw49h6RbvswhasBk9bXj7PzOD8GDW3kG1).
Proposez de nouvelles vidéos, c'est très facile à faire !
- Les pages Web comme celle que vous lisez actuellement. La documentation est
générée via `MkDocs, un système très simple basé sur le format
[Markdown](https://www.markdownguide.org/basic-syntax/). Toutes les sources
sont sur le [dépôt git DocScoDoc](https://scodoc.org/git/viennet/DocScoDoc).
- Les pages Web comme celle que vous lisez actuellement. La documentation est
générée via `MkDocs, un système très simple basé sur le format
[Markdown](https://www.markdownguide.org/basic-syntax/). Toutes les sources
sont sur le [dépôt git DocScoDoc](https://scodoc.org/git/viennet/DocScoDoc).
## Contribuer au logiciel
Le [dépot principal](https://scodoc.org/git/viennet/ScoDoc) comporte plusieurs
Le [dépôt principal](https://scodoc.org/git/viennet/ScoDoc) comporte plusieurs
branches. Voir le [guide pour les développeurs](GuideDeveloppeurs.md).

6
docs/FAQ.md
View File

@ -175,4 +175,10 @@ Voir les commandes d'administration dans [GuideConfig](GuideConfig.md)
### Comment contribuer au projet ?
[Voir la page](Contribuer.md).
!!! note "Voir aussi"
- [Contacts](Contact.md).
- <a href="https://www.youtube.com/playlist?list=PLw49h6RbvswhasBk9bXj7PzOD8GDW3kG1" target="_blank">Tutoriels sur YouTube <img src="/img/tube.png" alt="" style="margin-top:0px; margin-bottom:0px; border-width:0px;"/></a>

40
docs/GuideAdminSys.md
View File

@ -6,36 +6,38 @@ Utilisez un **serveur virtuel** ou un container Docker si vous n'avez pas de mac
## Installation
* Installation de ScoDoc: [GuideInstallDebian11](GuideInstallDebian11.md)
* Migration d'un serveur ScoDoc 7 vers la nouvelle version Scodoc 9: [MigrationScoDoc7a9](MigrationScoDoc7a9.md)
* Installation de ScoDoc: [GuideInstallDebian11](GuideInstallDebian11.md)
* Migration d'un serveur ScoDoc 7 vers la nouvelle version Scodoc 9: [MigrationScoDoc7a9](MigrationScoDoc7a9.md)
## Mises à jour et sauvegardes
* [Mettre à jour du logiciel (nouvelles versions)](MisesAJour.md)
* [Mise en place de sauvegardes des bases de données](SauvegardesBases.md)
* [Mettre à jour du logiciel (nouvelles versions)](MisesAJour.md)
* [Mise en place de sauvegardes des bases de données](SauvegardesBases.md)
## Configuration et préférences
* [Administration en ligne de commande](GuideConfig.md)
* [ConfigPermissions](ConfigPermissions.md) : description des permissions et rôles utilisés par le système.
* [Paramétrage](PreferencesScoDoc.md): réglage des préférences
* [Gestion des comptes utilisateurs](AdminUsers.md)
* [Administration en ligne de commande](GuideConfig.md)
* [ConfigPermissions](ConfigPermissions.md) : description des permissions et rôles utilisés par le système.
* [Paramétrage](PreferencesScoDoc.md): réglage des préférences
## Autres problèmes
* [Problèmes configuration des envois mail](ProblemesMail.md)
* [Gestion des logos et fonds de documents](GestionLogos.md)
* [ProblemesEtBugs](ProblemesEtBugs.md) en cas d'ennuis.
* [Problèmes configuration des envois mail](ProblemesMail.md)
* [Gestion des logos et fonds de documents](GestionLogos.md)
* [ProblemesEtBugs](ProblemesEtBugs.md) en cas d'ennuis.
## Utilisation avancée
## Utilisation avancée
* [Interfaçage avec Apogée](ScoDocApogee.md)
* [API](ScoDoc9API.md) : API JSON ou XML pour interfaçage avec d'autres applications
* [ServicesXml](ServicesXml.md) : web services XML pour interfaçage avec d'autres applications (obsolète).
* [AdminUsers](AdminUsers.md) : gestion des utilisateurs
* [InterrogationPortail](InterrogationPortail.md) : liaison avec portail
* [Interfaçage avec Apogée](ScoDocApogee.md)
* [API](ScoDoc9API.md) : API JSON ou XML pour interfaçage avec d'autres applications
* [ServicesXml](ServicesXml.md) : web services XML pour interfaçage avec d'autres applications (obsolète).
* [InterrogationPortail](InterrogationPortail.md) : liaison avec portail
Voir aussi le [guide pour les développeurs](GuideDeveloppeurs.md) et la [FAQ](FAQ.md).
!!! note "Voir aussi"
- [Guide pour les développeurs](GuideDeveloppeurs.md)
- [FAQ](FAQ.md)
- [Contacts](Contact.md).

10
docs/GuideDeveloppeurs.md
View File

@ -4,8 +4,8 @@ Informations pour les développeurs souhaitant étendre ou modifier ScoDoc.
## Informations générales
* S'abonner aux [listes de diffusion](ListesDeDiffusion.md). Il y a aussi
un serveur Discord ouvert sur invitation aux développeur actifs. Contacter Emmanuel.
* Voir [contacts](Contact.md). Il y a aussi un serveur Discord ouvert sur
invitation aux développeur actifs. Contacter Emmanuel Viennet.
* [Générer de nouveaux formats de bulletins PDF](ApiGenerationBulletinsPdf.md)
* [Créer de nouveaux types de "parcours"](ApiCreationParcours.md)
* [API](ScoDoc9API.md) : API JSON ou XML pour interfaçage avec d'autres applications
@ -26,7 +26,7 @@ Quelques conseils, indications et mémos pour les développeurs sur ScoDoc versi
L'ancienneté de la base de code a rendu le style un peu incohérent, mais cela
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 formaté avec [`black`](https://black.readthedocs.io/) avant
tout commit (configurez votre éditeur pour appeler `black` à l'enregistrement).
#### Documentation
@ -100,8 +100,8 @@ mises à jour de `master` (remote), faire:
#### Commandes utiles, en vrac
* `git log -L:fonction_python:fichier.py`
* Commits locaux: `git log @{u}..`
* `git log -L:fonction_python:fichier.py`
* Commits locaux: `git log @{u}..`
#### Refactoring

189
docs/GuideInstallDebian11.md
View File

@ -1,5 +1,6 @@
# Installation de ScoDoc 9 sur Debian 11 (Bullseye)
# Installation de ScoDoc 9 sur Debian 11 (Bullseye)
Ce document décrit la procédure d'installation et de configuration de ScoDoc 9.
Cette procédure doit être effectué sur la machine serveur avec un accès
administrateur (root).
@ -19,19 +20,16 @@ autre version.
Si vous mettez à jour un serveur existant (ScoDoc 7 sur Debian 10), voir [la page
sur les migrations](https://scodoc.org/MigrationScoDoc7a9/#2-upgrade-debian).
Merci de signaler tout problème (emmanuel.viennet@gmail.com
ou [scodoc-devel](https://listes.univ-paris13.fr/mailman/listinfo/scodoc-devel) ).
Merci de signaler tout problème [sur le Discord](https://discord.gg/ybw6ugtFsZ)
ou éventuellement la liste [scodoc-devel](https://listes.univ-paris13.fr/mailman/listinfo/scodoc-devel) ).
- Note 1: l'image du CD d'installation de Debian (amd64) peut se trouver ici:
- Note: 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 la version "petits CD" pour **amd64** (*Il est indispensable
d'utiliser une version 64 bits ! *)
- Note 2: une version Docker serait utile: avis aux volontaires.
choisir la version "petits CD" pour **amd64**
(*Il est indispensable d'utiliser une version 64 bits !*)
<img src="/img/alert.png" style="vertical-align: bottom; margin:0 0 0 0;" alt="/!\" /> Important:
🚸 **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
@ -39,49 +37,54 @@ nombreux paramètres de votre système Linux (serveur web, firewall, serveur SQL
messagerie, ...).
## 1) Préalable: configurer un serveur linux
## 1) Préalable: configurer un serveur linux
Le serveur devrait être accessible depuis Internet.
### Configuration matérielle
- taille disque: prévoir au moins 20Go sur la partition où sera scodoc (en
général `/`).
- taille disque: prévoir au moins 20Go sur la partition où sera scodoc (en
général `/`).
- mémoire: prévoir au moins 8Go de RAM, et plutôt 12 ou 16.
- mémoire: prévoir au moins 8Go de RAM, et plutôt 12 ou 16.
### Informations sur les flux réseau
Le serveur est fréquemment installé sur un réseau protégé ou sur un VPN.
- le trafic entrant est sur le port 443 (le trafic http/80 est redirigé
vers le https).
- le trafic entrant est sur le port 443 (le trafic http/80 est redirigé
vers le https).
- le serveur doit pouvoir envoyer du mail (serveur postfix en local, à
configurer pour utiliser un relais smtp ou envoyer directement, selon
votre politique. Au besoin, pour le reconfigurer, lancer `dpkg-reconfigure postfix`);
- le serveur doit pouvoir envoyer du mail (serveur Postfix en local, à
configurer pour utiliser un relais smtp ou envoyer directement, selon
votre politique. Au besoin, pour le reconfigurer, lancer `dpkg-reconfigure postfix`);
- Les serveurs de mise à jour de Debian doivent être accessibles (en http,
voir `/etc/apt/sources.list`);
- Les serveurs de mise à jour de Debian doivent être accessibles (en http,
voir `/etc/apt/sources.list`);
- Les serveurs `scodoc.org` et `scodoc.iutv.univ-paris13.fr` doivent
être accessibles (80 et 443).
- Les serveurs `scodoc.org` et `scodoc.iutv.univ-paris13.fr` **doivent**
être accessibles (80 et 443).
### Installation Linux Debian
Nous recommandons d'effectuer une installation standard de Debian par le réseau (netinst),
et d'utiliser l'install en mode texte, très simple et rapide.
et d'utiliser l'installation en mode texte, très simple et rapide.
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.).
*Veiller à sélectionner une locale `UTF-8` par défaut.*
🚸 *Veiller à sélectionner une locale `UTF-8` par défaut.*
![InstallDebian6-1.png](screens/InstallDebian6-1.png)
### Points à vérifier avant d'installer ScoDoc
### 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:
```
```bash
ping www.univ-paris13.fr
(quitter avec ctrl-c)
cd /tmp
@ -90,15 +93,16 @@ Checklist minimale de votre système Linux Debian:
```
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
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.
4. Mail: vérifiez que le serveur peut envoyer des e-mail:
`mail votre@adresse.fr`, puis entrer un message terminé par `ctrl-d`: si vous ne
4. Mail: vérifiez que le serveur peut envoyer des e-mail: `mail
votre@adresse.fr`, puis entrer un message terminé par `ctrl-d`: si vous ne
recevez pas le message après quelques minutes, vérifiez votre configuration
(et le log `/var/log/mail.log`). Un serveur ScoDoc qui n'envoie pas de mail
ne peut pas vérifier ceux des utilisateurs, qui à leur tour ne pourront pas
changer leurs mots de passe (bien d'autres fonctions dépendent des mails).
Au besoin, revoir la configuration avec `dpkg-reconfigure postfix`.
Au besoin, revoir la configuration avec `dpkg-reconfigure postfix` (voir
aussi [envoi des courriers électroniques](ProblemesMail.md)).
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`.
@ -112,22 +116,27 @@ Checklist minimale de votre système Linux Debian:
production, mettez en place des sauvegardes sérieuses !
#### Configuration si utilisation d'un proxy
Si votre accès à Internet passe par un proxy, l'indiquer au moment de
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 :
```
```bash
HTTP_PROXY=http://proxy.univ-xxx.fr:1234
HTTPS_PROXY=http://proxy.univ-xxx.fr:1234
```
Vérifiez aussi que ces variables sont bien définies dans `/etc/environment`
(si l'installeur Linux Debian ne les a pas déjà indiquées là, les ajouter ou créer ce fichier).
Après modification de ce fichier (qui _doit_ être lisible par l'utilisateur `scodoc`),
Vérifiez aussi que ces variables sont bien définies dans `/etc/environment` (si
l'installeur Linux Debian ne les a pas déjà indiquées là, les ajouter ou créer
ce fichier).
Après modification de ce fichier (qui *doit* être lisible par l'utilisateur `scodoc`),
redémarrer le service:
```
```bash
sudo systemctl restart scodoc
```
@ -146,11 +155,14 @@ root et/ou sudo, attention: la config par défaut de Redis (un gestionnaire de
cache utilisé par ScoDoc) n'est pas compatible, en raison d'un problème de
système de fichier en lecture seule. Installer redis avant ScoDoc, comme suit:
```bash
apt-get install redis
```
Puis créer un dossier `/etc/systemd/system/redis.service.d` contenant le fichier
`redis.conf` avec les lignes suivantes :
```text
[Service]
PrivateTmp=no
ProtectSystem=false
@ -161,11 +173,14 @@ Puis créer un dossier `/etc/systemd/system/redis.service.d` contenant le fichie
ProtectKernelModules=no
ReadWritePaths=
ReadOnlyDirectories=
```
Ensuite
```bash
systemctl daemon-reload
systemctl start redis
```
... et poursuivez l'installation comme ci-dessous.
@ -173,88 +188,99 @@ Ensuite
compte utilisateur normal, vous pouvez activer l'option « nesting »
(imbriqué) de LXC pour permettre à Redis de fonctionner normalement.
⚠️ Attention ! N'activez pas le *nesting* sur un conteneur privilégié. Cela
🚸 Attention ! N'activez pas le *nesting* sur un conteneur privilégié. Cela
provoquerait une faille de sécurité.
Si vous avez construit votre conteneur manuellement avec lxc-create, modifiez
Si vous avez construit votre conteneur manuellement avec `lxc-create`, modifiez
le fichier `/var/lib/lxc/${nomDuConteneur}/config` et ajoutez les lignes
ci-dessous :
```text
lxc.apparmor.allow_nesting = 1
lxc.apparmor.profile = generated
```
Si vous utilisez un conteneur LXC sur l'hyperviseur Proxmox, modifiez le
fichier `/etc/pve/lxc/${CTID}.conf` et ajoutez la ligne suivante :
```text
features: nesting=1
```
... et poursuivez l'installation comme ci-dessous.
## 2) Installation de ScoDoc sur Debian
## 2) Installation de ScoDoc sur Debian
### 2.1) Charger le logiciel
<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**).
🚸 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**).
Remarque: *Si ce n'est pas déjà le cas, vous avez intérêt à ouvrir une session
`ssh` (ou `putty`) depuis une machine normale, afin de pouvoir copier/coller
facilement les commandes et éditer les fichiers de configuration.*
- Ajouter le dépot scodoc: copier ce fichier <a href="/attachments/scodoc.list"
- Ajouter le dépot scodoc: copier ce fichier <a href="/attachments/scodoc.list"
download>scodoc.list</a> dans `/etc/apt/sources.list.d/`
ou le créer contenant juste cette ligne:
# contenu du fichier /etc/apt/sources.list.d/scodoc.list
deb http://scodoc.org/repo bullseye main
```text
# contenu du fichier /etc/apt/sources.list.d/scodoc.list
deb http://scodoc.org/repo bullseye main
```
- Installer la clé: en `root` sur le serveur, lancer
- Installer la clé: en `root` sur le serveur, lancer
```bash
apt-get -y install gnupg
wget -O - https://scodoc.org/misc/scodoc-repo.gpg.key | apt-key add -
```
apt-get -y install gnupg
wget -O - https://scodoc.org/misc/scodoc-repo.gpg.key | apt-key add -
- Installer le logiciel:
- Installer le logiciel:
```bash
apt-get update
apt-get install nginx
```
S'assurer que le logiciel `nginx` s'est bien installé. En cas de problème se
référer à sa doc (par exemple, si
[votre serveur ne supporte pas
IPv6](https://techglimpse.com/nginx-error-address-family-solution/)).
apt-get update
apt-get install nginx
Ensuite:
S'assurer que le logiciel `nginx`s'est bien installé. En cas de problème se
référer à sa doc (par exemple, si
[votre serveur ne supporte pas
IPv6](https://techglimpse.com/nginx-error-address-family-solution/)).
```bash
apt-get install scodoc9
```
Notez que l'installation du paquet `scodoc9` va créer automatiquement un
utilisateur `scodoc` qui sera utilisé par le serveur.
Ensuite:
apt-get install scodoc9
Notez que l'installation du paquet `scodoc9` va créer automatiquement un
utilisateur `scodoc` qui sera utilisé par le serveur.
- Attribuer un mot de passe à l'utilisateur `scodoc`:
passwd scodoc
- Attribuer un mot de passe à l'utilisateur `scodoc`:
```bash
passwd scodoc
```
### 2.2) Configuration des logiciels et des données
Lancer le script suivant en tant que `root` sur votre serveur nouvellement installé:
/opt/scodoc/tools/configure-scodoc9.sh
```bash
/opt/scodoc/tools/configure-scodoc9.sh
```
Vous devrez répondre à quelques questions et saisir le mot de passe que vous
attribuerez à l'utilisateur `admin`.
(note: pour en savoir plus sur ce script, [voir l'explication](GuideInstallDebian11Advanced.md))
### 3) **Lancer ScoDoc**:
### 3) **Lancer ScoDoc**
sudo su # se connecter en root
systemctl restart nginx
systemctl restart scodoc9
et voila !
```bash
sudo su # se connecter en root
systemctl restart nginx
systemctl restart scodoc9
```
✨ et voila !
Visiter `https://monscodoc.mondomaine.fr/` pour achever la configuration et
utiliser le logiciel: voir la page [GuideConfig](GuideConfig.md).
@ -267,19 +293,18 @@ installation ScoDoc 7, ou même en place.
Voir [la procédure de migration](MigrationScoDoc7a9.md).
## En cas de problème
Ne pas hésiter à me contacter ou à écrire sur la liste notes (voir [Listes de
diffusion](ListesDeDiffusion.md)).
## En cas de problème
* Problèmes d'envoi de courrier électronique (mail): voir [ProblemesMail](ProblemesMail.md)
Ne pas hésiter à nous contacter (voir [contacts](Contact.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...
## Ensuite...
- Mettez en place des [sauvegardes](SauvegardesBases.md)
* Mettez en place des [sauvegardes](SauvegardesBases.md)
* Abonnez-vous au moins à la liste d'annonces: voir [Listes de diffusion](ListesDeDiffusion.md)
- Abonnez-vous au moins à la liste d'annonces: voir [contacts](Contact.md)

11
docs/ListesDeDiffusion.md
View File

@ -1,11 +0,0 @@
# Listes de diffusion mail pour ScoDoc
Les listes de diffusion mail sont le principal canal de communication entre les utilisateurs et entre les développeurs.
* [scodoc-annonces](https://listes.univ-paris13.fr/mailman/listinfo/scodoc-annonces) liste à très fable trafic, en lecture seule, seules des annonces importantes sont postées (quelques messages par an), tous les utilisateurs sont encouragés à s'y abonner. Indispensable aux administrateurs du logiciel.
* [Notes](https://listes.univ-paris13.fr/mailman/listinfo/notes) discussions ou questions liées à l'utilisation du logiciel, entraide entre utilisateurs: vous pouvez y intervenir librement (les messages sont modérés pour éviter le spam).
* [scodoc-devel](https://listes.univ-paris13.fr/mailman/listinfo/scodoc-devel) échanges entre développeurs. Abonnez-vous si vous êtes intéressés par le développement du logiciel, souhaitez participer ou poser des questions techniques.

69
docs/PresentationGenerale.md
View File

@ -1,56 +1,93 @@
# Présentation rapide de ScoDoc
Voir les <a href="https://www.youtube.com/playlist?list=PLw49h6RbvswhasBk9bXj7PzOD8GDW3kG1" target="_blank">Vidéos d'introduction sur YouTube <img src="img/tube.png" alt="" style="margin-top:0px; margin-bottom:0px; border-width:0px;"/></a>
Voir les <a href="https://www.youtube.com/playlist?list=PLw49h6RbvswhasBk9bXj7PzOD8GDW3kG1" target="_blank">Vidéos d'introduction sur YouTube <img src="/img/tube.png" alt="" style="margin-top:0px; margin-bottom:0px; border-width:0px;"/></a>
## Page d'accueil
![accueil](screens/accueil-scodoc7.png)
On y trouve les éléments suivants:
La colonne de gauche indique l'identité de l'utilisateur connecté (en rouge à droite) et contient des liens facilitant la navigation sur le site (certains sont paramétrables à l'installation). On note l'accès à trois composants importants: Entreprises (fichier d'entreprises), Notes (gestion des notes), Absences (relevé des absences), et un champ de texte permettant de rechercher un étudiant par son nom.
La colonne de gauche indique l'identité de l'utilisateur connecté (en rouge à
droite) et contient des liens facilitant la navigation sur le site (certains
sont paramétrables à l'installation). On note l'accès à trois composants
importants: Entreprises (fichier d'entreprises), Notes (gestion des notes),
Absences (relevé des absences), et un champ de texte permettant de rechercher un
étudiant par son nom.
L'identité de l'utilisateur défini ses droits d'accès (rôle) et les fonctions qu'il peut utiliser.
L'identité de l'utilisateur défini ses droits d'accès (rôle) et les fonctions
qu'il peut utiliser.
Le centre de la page donne les formations (sessions) en cours, groupées par type. A côté du titre de chaque formation, on a le nom de son responsable (ou directeur des études dans le jargon IUT), ainsi que les dates de début et de fin de la session.
Le centre de la page donne les formations (sessions) en cours, groupées par
type. A côté du titre de chaque formation, on a le nom de son responsable (ou
directeur des études dans le jargon IUT), ainsi que les dates de début et de fin
de la session.
## Fiche étudiant
Pour accéder à la fiche d'un étudiant, on peut soit le rechercher par nom (voir RechercheEtudiant) soit cliquer sur un lien dans une liste ou sur une photo d'un trombinoscope. Cette fiche (exemple ci-dessous) donne accès à toutes les informations sur l'étudiant.
![fiche étudiant](screens/ficheEtud-scodoc7.png)
Pour accéder à la fiche d'un étudiant, on peut soit le rechercher par nom (voir
RechercheEtudiant) soit cliquer sur un lien dans une liste ou sur une photo d'un
trombinoscope. Cette fiche (exemple ci-dessous) donne accès à toutes les
informations sur l'étudiant. ![fiche étudiant](screens/ficheEtud-scodoc7.png)
## Suivi de l'assiduité
ScoDoc permet d'enregistrer les absences des étudiants puis de les visualiser sur un calendrier. On peut aussi obtenir des comptes d'absences, générer des alarmes par e-mail pour prévenir un responsable, vérifier les absences qui coincident avec un examen, enregistre les justificatifs, etc.
![calendrier des absences](screens/calabs-scodoc7.png)
ScoDoc permet d'enregistrer les absences des étudiants puis de les visualiser
sur un calendrier. On peut aussi obtenir des comptes d'absences, générer des
alarmes par e-mail pour prévenir un responsable, vérifier les absences qui
coincident avec un examen, enregistre les justificatifs, etc. ![calendrier des
absences](screens/calabs-scodoc7.png)
## Gestion des notes
La gestion des notes est la partie principale du logiciel et est conçue pour faciliter au maximum le travail des enseignants, grâce à une grande flexibilité (définition des évaluations, import/export via Excel ou saisie sur formulaire web, vérifications, etc.).
La gestion des notes est la partie principale du logiciel et est conçue pour
faciliter au maximum le travail des enseignants, grâce à une grande flexibilité
(définition des évaluations, import/export via Excel ou saisie sur formulaire
web, vérifications, etc.).
### Tableau de bord du semestre, avec les modules
![tableau de bord du semestre](screens/tableaubord2011.png)
### Tableau récapitulatif des moyennes
![tableau de bord du semestre](screens/NotesRecap2012-crop.png)
### Bulletins de notes
Les bulletins sont affichables selon différents formats (ci-dessous le format par défaut). Ils peuvent être exportés sous forme de document PDF (pour impression papier), à d'autres formats (XML, Excel) ou directement envoyé par mail aux étudiants.
![bulletin de note web](screens/BulletinInter2012-crop.png)
Les bulletins sont affichables selon différents formats (ci-dessous le format
par défaut). Ils peuvent être exportés sous forme de document PDF (pour
impression papier), à d'autres formats (XML, Excel) ou directement envoyé par
mail aux étudiants. ![bulletin de note web](screens/BulletinInter2012-crop.png)
## Gestion des jurys et commissions
Une interface permet la saisie des décisions de jury. Le parcours de l'étudiant (redoublements, validations antérieures, compensations entre semestres, capitalisations d'UE) est automatiquement pris en compte, permettant aux enseignant de se concentrer sur les aspects pédagogiques sans perdre de temps avec la gestion administrative (parfois assez complexe).
ScoDoc intègre la gestion des jurys des DUT (2005) et bientôt du Bachelor Universitaire de technologie (BUT) et s'assure que les décisions prises respectent les règles.
Une interface permet la saisie des décisions de jury. Le parcours de l'étudiant
(redoublements, validations antérieures, compensations entre semestres,
capitalisations d'UE) est automatiquement pris en compte, permettant aux
enseignant de se concentrer sur les aspects pédagogiques sans perdre de temps
avec la gestion administrative (parfois assez complexe).
ScoDoc intègre la gestion des jurys des DUT (2005) et bientôt du Bachelor
Universitaire de technologie (BUT) et s'assure que les décisions prises
respectent les règles.
## Gestion des groupes
ScoDoc permet de définir des partitions et groupes en nombre quelconque, et d'y répartir facilement les étudiants (glisser/déposer, fonctions de répartition automatiques).
![affectation aux groupes](screens/GroupesDnD.png)
ScoDoc permet de définir des partitions et groupes en nombre quelconque, et d'y
répartir facilement les étudiants (glisser/déposer, fonctions de répartition
automatiques). ![affectation aux groupes](screens/GroupesDnD.png)
## Trombinoscopes
![trombinoscope](screens/Trombi-scodoc7.png)
*(en réalité vous aurez les photos de vos étudiants !)*
## Autres fonctionnalités
### Imports / Exports
Les données conservées dans le logiciel peuvent être exportées dans une grande variété de formats (pages web, PDF, Excel, XML...) ce qui facilite tant son usage par des non informaticiens que son intégration dans d'autres logiciels (portails d'établissements, systèmes d'informations comme Apogée).
Les données conservées dans le logiciel peuvent être exportées dans une grande
variété de formats (pages web, PDF, Excel, XML...) ce qui facilite tant son
usage par des non informaticiens que son intégration dans d'autres logiciels
(portails d'établissements, systèmes d'informations comme Apogée).

29
docs/ProblemesMail.md
View File

@ -1,12 +1,15 @@
# Problèmes d'envoi de courriers électroniques
ScoDoc envoie des mails en plusieurs occasions (bulletins de notes, importation
d'utilisateurs, alertes sur absences, exceptions dans le code).
# Problèmes d'envoi de courriers électroniques
ScoDoc envoie des mails (emails, ou e-mails, ou courriels) en plusieurs
occasions (bulletins de notes, importation d'utilisateurs, alertes sur absences,
exceptions dans le code).
Cette page explique ce qu'il faut vérifier si l'envoi des messages ne fonctionne
pas.
## Configuration du serveur
ScoDoc suppose que la machine serveur sur laquelle il s'exécute est dotée d'un
serveur de mail capable d'envoyer des messages (soit directement, soit via un
relais). L'installeur propose d'installer le logiciel serveur Postfix.
@ -14,27 +17,33 @@ relais). L'installeur propose d'installer le logiciel serveur Postfix.
1. Vérifier que votre serveur de messagerie est bien configuré: dans un
terminal, envoyez un message
```
```bash
mail mon_adresse@universite.fr
... entrer votre texte, terminez par ctrl-d ...
```
Si vous ne recevez pas le message que vous vous envoyiez, revoir la
configuration de votre serveur, par exemple avec la commande
```
```bash
dpkg-reconfigure postfix
```
2. Vérifiez que le serveur SMTP écoute bien en local sur le port 25: dans un terminal taper
```
```text
telnet localhost 25
```
Vous devez observer:
```
```text
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
220 nom_du_serveur ESMTP Postfix (Debian/GNU)
```
(quitter avec ctrl-] puis `quit`)
## Tests avec ScoDoc
@ -75,3 +84,9 @@ notification ou de bulletins sans déranger les étudiants ou les collègues).
Pour cela, aller sur la page *Paramétrage*, tout en bas, et indiquer une
*Adresse de test*. Ne pas oublier de l'enlever une fois les essais effectués !
!!! note "Voir aussi"
- Pour la configuration des messages envoyés par ScoDoc, la page [Configuration des envois d'emails](ConfigEmail.md)
- [Guide administrateur ScoDoc](GuideAdminSys.md)
- [Contacts](Contact.md)

9
docs/TransitionSemestre.md
View File

@ -58,15 +58,14 @@ A ce stade, le semestre est terminé. Il est recommandé de le **verrouiller** a
6. (optionnel) Répartir les étudiants dans des groupes de TD (*Inscriptions / Modifier les groupes*).
C'est prêt. Les enseignants autorisés peuvent créer des évaluations et saisir des notes.
## Problèmes couramment rencontrés
- **Etudiants en doubles**: ceci arrive lorsqu'on crée manuellement les étudiants. Il faut absolument éviter de créer un étudiant qui existe déjà, sinon on perd la possibilité de suivre le parcours de chacun. Le respect de la procédure ci-dessus garanti normalement que les étudiants restent uniques. N'utiliser *créer un nouvel étudiant* qu'après vous être assuré qu'il n'était pas déjà inscrit dans un autre semestre, et que l'on sait que l'on ne va pas l'importer depuis Apogée.
- **Etudiants en doubles**: ceci arrive lorsqu'on crée manuellement les étudiants. Il faut absolument éviter de créer un étudiant qui existe déjà, sinon on perd la possibilité de suivre le parcours de chacun. Le respect de la procédure ci-dessus garanti normalement que les étudiants restent uniques. N'utiliser *créer un nouvel étudiant* qu'après vous être assuré qu'il n'était pas déjà inscrit dans un autre semestre, et que l'on sait que l'on ne va pas l'importer depuis Apogée.
- **Désinscription d'un étudiant**: si vous avez inscrit par erreur un étudiant dans un semestre, ce n'est pas grave: vous pouvez le désinscrire en utilisant le menu *Scolarité / désinscrire* sur sa fiche individuelle (à droite du nom du semestre concerné).
- **Désinscription d'un étudiant**: si vous avez inscrit par erreur un étudiant dans un semestre, ce n'est pas grave: vous pouvez le désinscrire en utilisant le menu *Scolarité / désinscrire* sur sa fiche individuelle (à droite du nom du semestre concerné).
- **Aucun étudiant à inscrire**: cela peut arriver si les dates de semestres sont incorrectes (chevauchement): en particulier, vérifier que la date de début du nouveau semestre est bien postérieure à la date de fin des semestres d'où proviennent les étudiants à inscrire.
- **Aucun étudiant à inscrire**: cela peut arriver si les dates de semestres sont incorrectes (chevauchement): en particulier, vérifier que la date de début du nouveau semestre est bien postérieure à la date de fin des semestres d'où proviennent les étudiants à inscrire.
Pour toutes questions, n'hésitez pas à contacter la liste de diffusion Notes (voir la [page d'information sur les listes](ListesDeDiffusion.md)).
Pour toutes questions, n'hésitez pas à nous contacter (voir la [contacts](Contact.md)).

BIN
docs/fig/config-accueil.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 56 KiB

BIN
docs/fig/config-cas-cnx.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 80 KiB

BIN
docs/fig/config-cas-user.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 138 KiB

BIN
docs/fig/config-cas.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 194 KiB

BIN
docs/fig/config-dept-abs.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 219 KiB

BIN
docs/fig/config-dept-mail.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 47 KiB

BIN
docs/fig/config-generale-mail.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 35 KiB

BIN
docs/fig/envoi-assistance.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 13 KiB

86
docs/index.md
View File

@ -6,16 +6,15 @@ des étudiants universitaires. Il est principalement utilisé dans les IUT, mais
aussi apprécié par plusieurs Écoles et Masters en France et à l'étranger. Il
fournit notamment:
- suivi précis de la progression des étudiants, évaluations formatives et
certificatives
- saisie et gestion des notes;
- aide à la décision pour les jurys;
- listes des étudiants (groupes, trombinoscopes, bordereaux divers);
- suivi de l'assiduité (saisie et visualisation des absences);
- tableaux de bords, rapports statistiques sur la formation (suivis de
cohortes, ...) utiles pour l'évaluation et le suivi des formations;
- édition des procès-verbaux, bulletins et autres documents liés à la scolarité.
- suivi précis de la progression des étudiants, évaluations formatives et
certificatives
- saisie et gestion des notes;
- aide à la décision pour les jurys;
- listes des étudiants (groupes, trombinoscopes, bordereaux divers);
- suivi de l'assiduité (saisie et visualisation des absences);
- tableaux de bord, rapports statistiques sur la formation (suivis de
cohortes, ...) utiles pour l'évaluation et le suivi des formations;
- édition des procès-verbaux, bulletins et autres documents liés à la scolarité.
ScoDoc est un *logiciel libre*: vous pouvez [participer à son développement](Contribuer.md).
@ -35,26 +34,29 @@ retourner à `Emmanuel.Viennet at gmail.com`.
## Présentation générale
- [Présentation générale du logiciel avec copies d'écran](PresentationGenerale.md)
- [Présentation générale du logiciel avec copies d'écran](PresentationGenerale.md)
- Quelques <a href="https://www.youtube.com/playlist?list=PLw49h6RbvswhasBk9bXj7PzOD8GDW3kG1" target="_blank">vidéos d'introduction sur YouTube <img src="img/tube.png" alt="" style="margin-top:0px; margin-bottom:0px; border-width:0px;"/></a>
- Ancienne présentation au colloque du [CRI-IUT](https://www.criiut.fr/) en 2013: [diapos en pdf](papers/presScoDocCRIIUT2013.pdf)
- Un très ancien [article sur ScoDoc](papers/scodoc-reunion2007.pdf)
- Quelques <a href="https://www.youtube.com/playlist?list=PLw49h6RbvswhasBk9bXj7PzOD8GDW3kG1" target="_blank">vidéos d'introduction sur YouTube <img src="/img/tube.png" alt="" style="margin-top:0px; margin-bottom:0px; border-width:0px;"/></a>
- très ancienne présentation au colloque du [CRI-IUT](https://www.criiut.fr/) en 2013: [diapos en pdf](papers/presScoDocCRIIUT2013.pdf)
- Un très très ancien [article sur ScoDoc](papers/scodoc-reunion2007.pdf)
## Communauté d'utilisateurs
- Le Discord des utilisateurs: assistance chat ou audio [rejoindre le salon](https://discord.gg/ybw6ugtFsZ)
- [Listes de diffusion e-mail](ListesDeDiffusion.md)
- Vous pouvez signaler ici des bugs ou déposer des suggestions d'amélioration via les "tickets":
* [Liste des tickets en cours](https://scodoc.org/git/viennet/ScoDoc/issues)
* Déclarer un nouveau ticket: demander un compte sur la liste `scodoc-devel` (lien ci-dessus).
- [Contribuer à ScoDoc](Contribuer.md)
- Le Discord des utilisateurs: assistance chat ou audio [rejoindre le salon](https://discord.gg/ybw6ugtFsZ)
- [contacts: Discord, listes, site](Contact.md)
- [Contribuer à ScoDoc](Contribuer.md)
## Actualités
### ScoDoc 9.4.x
Série en développement, centrés sur la gestion du *Bachelor Universitaire de
technologie* (BUT) mais aussi sur la modernisation du logiciel et sa meilleure
intégration dans les systèmes d'informations universitaires (API, CAS).
### Parution de ScoDoc 9 en 2021-2022
Version majeure, avec une architecture logicielle complètement remaniée. Cette
version modernise l'infrastructure logicielle (maintenant basée sur Python
3/Flask/postgresql) et propose de nombreuses améliorations, notamment pour la
@ -73,17 +75,19 @@ Orléans, LP IUT Villetaneuse):
### Stagiaires
- version spéciale pour mobiles, développée par un stagiaire de l'association;
- développements de tests unitaires et fonctionnels, par deux stagiaires, l'un
avec l'association, l'autre à l'IUT de Lille.
- affichage et édition des référentiels de BUT, avec un stagiaire de
l'association.
- version spéciale pour mobiles, développée par un stagiaire de l'association;
- développements de tests unitaires et fonctionnels, par deux stagiaires, l'un
avec l'association, l'autre à l'IUT de Lille.
- affichage et édition des référentiels de BUT, avec un stagiaire de
l'association.
### Nouveaux développeurs
Plusieurs développeurs volontaires, la plupart enseignants en IUT, ont rejoint
l'équipe depuis 2020.
### Bachelor Universitaire de Technologie (BUT) et ScoDoc
ScoDoc évolue pour intégrer la gestion du BUT, en approche par compétences, avec
des situations d'apprentissage et d'évaluation (SAÉs) et des ressources
pédagogiques. ScoDoc n'a pas vocation à devenir un portfolio APC, mais
@ -94,6 +98,7 @@ Des formats de bulletins de notes adaptés sont proposés pour faciliter la
compréhension des résultats par les étudiants et enseignants.
### ScoDoc et Pégase/PC-SCOL
Nous sommes en contact avec l'équipe du projet Pégase/PC-SCOL, qui succédera
dans certaines universités à Apogée. A court et moyen terme, ce nouvel outil ne
rendra pas les mêmes services que ScoDoc. Nous étudions dès maintenant
@ -102,23 +107,24 @@ l'interfaçage des outils (via des API), qui a priori sera plus fluide et facile
entente.
### Feuille de route (roadmap)
Les prochaines versions de ScoDoc :
- ScoDoc 9.5 : début 2023
- ScoDoc 9.5 : printemps 2023
- Nouveau système de suivi de l'assiduité (absences, présences)
- ScoDoc 9.4 : prévue à l'automne 2022
- ScoDoc 9.4 : décembre 2022
- cas complexes posés par les BUT (parcours, tenue des jury)
- nouveaux documents
- ScoDoc 9.3 : publiée en mai 2022
- ScoDoc 9.3 : publiée en mai 2022
- tenue des jurys BUT et exports Apogée
- gestion des parcours (pour la mise en place des semestre)
- nouvelle API
- module "relations entreprises"
- ScoDoc 9.2 : publiée en avril 2022 nouvelles fonctionnalités liées au BUT
- ScoDoc 9.2 : publiée en avril 2022 nouvelles fonctionnalités liées au BUT
- référentiels de compétences Orébut
- capitalisation des UE dans le BUT
- bonus/malus locaux
@ -126,7 +132,7 @@ Les prochaines versions de ScoDoc :
- nouveau module de gestion relations avec les entreprises
- ScoDoc 9.1 : décembre 2021 gestion du bachelor (BUT)
- ScoDoc 9.1 : décembre 2021 gestion du bachelor (BUT)
- type de formation BUT
- distinction SAE/ressources
- poids (coefs) des évaluations, affichage, édition
@ -135,12 +141,16 @@ Les prochaines versions de ScoDoc :
- calcul des moyennes d'UE
- bulletin de note v1
- ScoDoc 9.0 : publiée le 19 sept. 2021, version complètement remaniée en
Python 3/Flask.
- ScoDoc 9.0 : publiée le 19 sept. 2021, version complètement remaniée en
Python 3/Flask.
<br>
---
- [Guide utilisateur](GuideUtilisateur.md)
- Page web de l'auteur: <http://www-l2ti.univ-paris13.fr/~viennet>
!!! note "Voir aussi"
- [Guide utilisateur](GuideUtilisateur.md)
- <a href="https://www.youtube.com/playlist?list=PLw49h6RbvswhasBk9bXj7PzOD8GDW3kG1" target="_blank">Tutoriels sur YouTube <img src="/img/tube.png" alt="" style="margin-top:0px; margin-bottom:0px; border-width:0px;"/></a>
- [Contacts](Contact.md).
- Page web de l'auteur: <http://www-l2ti.univ-paris13.fr/~viennet>

3
mkdocs.yml
View File

@ -8,6 +8,7 @@ theme:
- navigation.tabs
- toc.follow
- navigation.top
- navigation.tracking
palette:
primary: light blue
language: fr
@ -47,7 +48,7 @@ nav:
- "Guide Développeurs": GuideDeveloppeurs.md
- "API (interfaçages autres logiciels)": ScoDoc9API.md
- FAQ: FAQ.md
- "Contacts": Contact.md
# theme: readthedocs