diff --git a/documentation/.gitignore b/documentation/.gitignore new file mode 100644 index 0000000..ac4e494 --- /dev/null +++ b/documentation/.gitignore @@ -0,0 +1,3 @@ +*.pdf +*.html +*.txt diff --git a/documentation/Makefile b/documentation/Makefile new file mode 100644 index 0000000..95af105 --- /dev/null +++ b/documentation/Makefile @@ -0,0 +1,23 @@ +PANDOC=pandoc +PANDOCFLAGS=--standalone --smart --toc -c pandoc.css +ALL=installation-base.pdf installation-base.html + +all: $(ALL) + +%.pdf: %.md + $(PANDOC) $(PANDOCFLAGS) --variable lang=french $< -o $@ + +%.tex: %.md + $(PANDOC) $(PANDOCFLAGS) --variable lang=french $< -o $@ + +%.html: %.md + $(PANDOC) $(PANDOCFLAGS) $< -o $@ + +%.txt: %.md + $(PANDOC) $(PANDOCFLAGS) $< -o $@ + +.PHONY: + +clean: + rm -f *.pdf *.html *.tex + diff --git a/documentation/images/authentic2-home.png b/documentation/images/authentic2-home.png new file mode 100644 index 0000000..aa9a9f6 Binary files /dev/null and b/documentation/images/authentic2-home.png differ diff --git a/documentation/images/authentic2-login.png b/documentation/images/authentic2-login.png new file mode 100644 index 0000000..ea58fe1 Binary files /dev/null and b/documentation/images/authentic2-login.png differ diff --git a/documentation/images/guichet-ajouter.png b/documentation/images/guichet-ajouter.png new file mode 100644 index 0000000..c3f0afe Binary files /dev/null and b/documentation/images/guichet-ajouter.png differ diff --git a/documentation/images/guichet-detail.png b/documentation/images/guichet-detail.png new file mode 100644 index 0000000..671c591 Binary files /dev/null and b/documentation/images/guichet-detail.png differ diff --git a/documentation/images/guichet-homepage.png b/documentation/images/guichet-homepage.png new file mode 100644 index 0000000..ffb3a6d Binary files /dev/null and b/documentation/images/guichet-homepage.png differ diff --git a/documentation/images/psl-boot-iso.png b/documentation/images/psl-boot-iso.png new file mode 100644 index 0000000..a37d8dd Binary files /dev/null and b/documentation/images/psl-boot-iso.png differ diff --git a/documentation/images/psl-iso-installee.png b/documentation/images/psl-iso-installee.png new file mode 100644 index 0000000..88bae39 Binary files /dev/null and b/documentation/images/psl-iso-installee.png differ diff --git a/documentation/images/psl-ldapsaisie-accueil.png b/documentation/images/psl-ldapsaisie-accueil.png new file mode 100644 index 0000000..0550598 Binary files /dev/null and b/documentation/images/psl-ldapsaisie-accueil.png differ diff --git a/documentation/images/psl-ldapsaisie-login.png b/documentation/images/psl-ldapsaisie-login.png new file mode 100644 index 0000000..c610cc9 Binary files /dev/null and b/documentation/images/psl-ldapsaisie-login.png differ diff --git a/documentation/images/psl-premier-login.png b/documentation/images/psl-premier-login.png new file mode 100644 index 0000000..ebd84a8 Binary files /dev/null and b/documentation/images/psl-premier-login.png differ diff --git a/documentation/images/psl-sql-2.png b/documentation/images/psl-sql-2.png new file mode 100644 index 0000000..f8cb29f Binary files /dev/null and b/documentation/images/psl-sql-2.png differ diff --git a/documentation/images/psl-sql.png b/documentation/images/psl-sql.png new file mode 100644 index 0000000..75ab20f Binary files /dev/null and b/documentation/images/psl-sql.png differ diff --git a/documentation/installation-base.md b/documentation/installation-base.md new file mode 100644 index 0000000..2e95822 --- /dev/null +++ b/documentation/installation-base.md @@ -0,0 +1,118 @@ +% Gestion d'identités PSL -- Installation de base +% Entr'ouvert SCOP -- http://www.entrouvert.com + +Matériel et infrastructure requis +================================= + +Note : pour simplifier la mise en place d'un test, les composants du système peuvent s'installer sur une machine unique. Cependant, pour la recette et surtout la production, les composants doivent être installés sur des machines isolées. + +Nous préconisons l'installation sur *machine virtuelle*. Tous les composants fonctionnent sur n'importe quelle machine virtuelle compatible Debian 7 (VMware, VirtualBox, kvm, etc). + +Configuration réseau commune +---------------------------- + +* L'installation est plus simple sur un réseau piloté par *DHCP*; +* Les machines doivent avoir accès à Internet, au moins DNS et HTTP, pour télécharger les paquets logiciels de la solution puis leur mise à jour; +* Les machines doivent disposer d'entrées DNS, par exemple `ldap.example.net`, `ldapsaisie.example.net`, `authentic.example.net` + +Serveur LDAP +------------ + +Caractéristiques minimales : + +* Processeur : Intel ou AMD64, *64 bits* (architecture nommée «amd64» pour Linux) 2 GHz monocoeur +* Mémoire vive: 2 Go +* Disque : 10 Go + +Réseau : + +* En entrée : accès LDAP (389/tcp) +* En sortie : DNS, web (pour mises à jour) + +Note : il est possible d'instancier plusieurs serveurs LDAP ayant tous la même configuration matérielle. + +Serveur interface de gestion du LDAP +------------------------------------ + +Caractéristiques minimales : + +* Processeur : Intel ou AMD64, *64 bits* (architecture nommée «amd64» pour Linux) 2 GHz monocoeur +* Mémoire vive: 2 Go +* Disque : 5 Go + +Réseau : + +* En entrée : accès HTTPS (443/tcp) +* En sortie : LDAP vers le(s) serveur(s) LDAP, DNS, web (pour mises à jour) + + +Serveur IdP +----------- + +Caractéristiques minimales : + +* Processeur : Intel ou AMD64, *64 bits* (architecture nommée «amd64» pour Linux) 2 GHz monocoeur +* Mémoire vive: 2 Go +* Disque : 5 Go + +Réseau : + +* En entrée : accès HTTPS (443/tcp) +* En sortie : LDAP vers le(s) serveur(s) LDAP, DNS, web HTTP et HTTPS (**chargement des métadonnées de fédération** et mises à jour logicielles) + + +Image ISO commune +================= + +Toutes les machines s'installent depuis la même image ISO. Télécharger le fichier `.iso` le plus récent disponible sur : + +> [http://deb.entrouvert.org/supann/](http://deb.entrouvert.org/supann/) + +Amorçage sur l'image ISO +======================== + +Pour lancer l'installation, il faut amorcer (_booter_) la machine choisie sur l'image ISO ; suivre pour cela la procédure de la machine, virtuelle ou non. + +**Attention: l'installation effacera toutes les données présentes sur la machine.** + +\ ![images/psl-boot-iso.png](images/psl-boot-iso.png) + +Choisir le mode d'installation de base: **`SupAnn base Install`** + +L'installation est celle d'une distribution Debian où la plupart des réponses ont déjà été faites. Les grandes étapes sont : + +1. Configuration des paramètres réseau si la machine n'arrive pas à s'autoconfigurer (par exemple, pas de DHCP) +1. Choix d'un mot de passe administrateur (utilisateur _root_) +1. Partitionnement : sauf si vous avez des besoins spécifiques, laisser le choix par défaut *«Assisté - utiliser un disque entier»* +1. Installation du système proprement dit (entre 2 et 10 minutes, selon la bande passante disponible et la rapidité de la machine) +1. Après la fin de l'installation, redémarrage (l'image ISO est retirée automatiquement du _boot_) + +\ ![images/psl-iso-installee.png](images/psl-iso-installee.png) + +Premier démarrage +----------------- + +Après le démarrage, se connecter en tant que `root` avec le mot de passe décidé lors de l'installation : + +\ ![images/psl-premier-login.png](images/psl-premier-login.png) + +Ajout d'outils supplémentaires +------------------------------ + +Par défaut, des outils Unix simples et relativement _user-friendly_ sont installés, tels que l'éditeur `nano` pour la modification des fichiers textes. + +Pour les utilisateurs habitués à l'utilisation de machines GNU/Linux, il est possible d'installer des composants d'administration qui aideront à la gestion quotidienne des machines. Tous les logiciels de **Debian GNU/Linux version 7 (Wheezy)** sont installables. Par exemple : + +* `apt-get install vim` et/ou`apt-get install emacs` +* `apt-get install ssh` +* `apt-get install screen` +* etc. + + +----- + +Historique du document +====================== + +> 20150217 tnoel -- première version + diff --git a/documentation/pandoc.css b/documentation/pandoc.css new file mode 100644 index 0000000..fa0b691 --- /dev/null +++ b/documentation/pandoc.css @@ -0,0 +1,87 @@ +body { + margin: auto; + padding-right: 1em; + padding-left: 1em; + max-width: 60em; + /* border-left: 1px solid black; + border-right: 1px solid black; */ + color: black; + line-height: 140%; + color: #000; + font-family: sans-serif; +} +pre { + border: 1px dotted gray; + background-color: #ececec; + color: #111; + padding: 0.5em; +} +code { + font-family: monospace; +} +h1 a, h2 a, h3 a, h4 a, h5 a { + text-decoration: none; + color: #000; +} +h1, h2, h3, h4, h5 { + color: #000; +} +h1 { + padding-top: 1em; + margin-top: 2em; + border-top: 1px dotted black; + font-size: 200%; +} + +h2 { +/* border-bottom: 1px dotted black; */ + font-size: 150%; + padding-top: 1em; +} + +h3 { + font-size: 120%; +} + +h4 { + font-size: 90%; + font-style: italic; +} + +h5 { + font-size: 90%; + font-style: italic; +} + +h1.title { + font-size: 200%; + font-weight: bold; + padding-top: 0.2em; + padding-bottom: 0.2em; + text-align: left; + border: none; +} + +dt code { + font-weight: bold; +} +dd p { + margin-top: 0; +} + +#footer { + padding-top: 1em; + font-size: 70%; + color: gray; + text-align: center; +} +div.figure { + padding-top: 1em; + padding-bottom: 1em; + border: 1px solid black; + text-align: center; +} +p.caption { + font-size: 80%; + font-style: italic; +}