diff options
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | conf.py | 2 | ||||
| -rw-r--r-- | glossary.md | 8 | ||||
| -rw-r--r-- | services/email.md | 7 | ||||
| -rw-r--r-- | services/ftp.md | 2 | ||||
| -rw-r--r-- | services/git.md | 6 | ||||
| -rw-r--r-- | services/mysql.md | 13 | ||||
| -rw-r--r-- | services/rss.md | 4 | ||||
| -rw-r--r-- | services/ssh.md | 10 | ||||
| -rw-r--r-- | services/web.md | 14 |
10 files changed, 38 insertions, 30 deletions
@@ -6,7 +6,7 @@ Meta-documentation La documentation de CLUB1 est publiée au format HTML à l'adresse <https://club1.fr/docs/fr/>. Elle existe en deux langues : français, la principale et anglais, la secondaire. -Le site web est généré à l'aide de +Le site {term}`Web` est généré à l'aide de [Sphinx](https://fr.wikipedia.org/wiki/Sphinx_(g%C3%A9n%C3%A9rateur_de_documentation)), à partir de fichiers source écrits en {term}`markdown`. Les fichiers source sont rangés dans un dossier, versionné avec {term}`Git` @@ -112,7 +112,7 @@ html_context = { html_theme_options = { 'prev_next_buttons_location': 'bottom', - 'style_external_links': False, + 'style_external_links': True, 'vcs_pageview_mode': 'edit', } diff --git a/glossary.md b/glossary.md index b8e09c2..201c95e 100644 --- a/glossary.md +++ b/glossary.md @@ -22,10 +22,11 @@ CLI [Wikipedia](https://fr.wikipedia.org/wiki/Interface_en_ligne_de_commande) Client - Logiciel permettant de se connecter à un {term}`serveur`. --- + Logiciel permettant de se connecter à un {term}`serveur`. + Il est en général doté d'une interface graphique, destinée à être utilisée directement par un humain. --- [Wikipedia](https://fr.wikipedia.org/wiki/Client_(informatique)) -Client web +Client Web {term}`Client` accessible via le {term}`Web` et ainsi exécuté par un Navigateur web. Git @@ -60,6 +61,7 @@ Serveur Web L'un des services les plus connus d'{term}`Internet`. Son nom complet est "World Wide Web" (aussi abrégé "www"). - Il permet de publier des documents et de les relier entre eux à l'aide de liens hypertexte. --- + Il permet de publier des documents et de les relier entre eux à l'aide de liens hypertexte. + On appelle "Navigateur Web" le {term}`client` utilisé pour y accéder. --- [Wikipedia](https://fr.wikipedia.org/wiki/World_Wide_Web) ``` diff --git a/services/email.md b/services/email.md index 2da4e2c..ea6236f 100644 --- a/services/email.md +++ b/services/email.md @@ -5,7 +5,8 @@ Chaque membre dispose d'une adresse email personnelle. Elle est composée de l'**identifiant**, suivi de `@club1.fr`. Par exemple, l'adresse de l'utilisateur `michel` est `michel@club1.fr`. -Un {term}`client web` est disponible à l'adresse <https://mail.club1.fr>. +Un {term}`client Web` fourni par [Roundcube](https://fr.wikipedia.org/wiki/Roundcube) +est disponible à l'adresse <https://mail.club1.fr>. Informations de connexion ------------------------- @@ -17,7 +18,7 @@ La connexion d'un client email à une adresse CLUB1 nécessite de configurer plu | champ | valeur | | ---------------- | --------------------- | | hôte | `mail.club1.fr` | -| port | `465` | +| port | `465` (par défaut) | | chiffrement | `SSL/TSL` (Implicite) | ### Serveur de réception (IMAP) @@ -25,5 +26,5 @@ La connexion d'un client email à une adresse CLUB1 nécessite de configurer plu | champ | valeur | | ---------------- | --------------------- | | hôte | `mail.club1.fr` | -| port | `993` | +| port | `993` (par défaut) | | chiffrement | `SSL/TSL` (Implicite) | diff --git a/services/ftp.md b/services/ftp.md index bac6fa9..1f2dc60 100644 --- a/services/ftp.md +++ b/services/ftp.md @@ -1,7 +1,7 @@ Transfert de fichiers FTPS ========================== -Bien que [ssh](ssh) puisse aussi être utilisé dans ce but, FTPS (_File Transfer +Bien que [SSH](ssh.md) puisse aussi être utilisé dans ce but, FTPS (_File Transfer Protocol Secure_) peut être utile lors du tranfert d'un grand nombre de fichiers depuis et vers le serveur CLUB1. diff --git a/services/git.md b/services/git.md index ead5453..69a4e02 100644 --- a/services/git.md +++ b/services/git.md @@ -13,7 +13,7 @@ Cette adresse permet 2 choses : 1. Cloner le dépôt Git avec `git clone` grâce au [git-http-backend](https://git-scm.com/docs/git-http-backend). 2. Consulter rapidement le dépôt et le sources dans un navigateur grâce à - l'interface web [cgit](https://git.zx2c4.com/cgit/about/). + l'interface {term}`Web` fournie par [cgit](https://git.zx2c4.com/cgit/about/). Tutoriel d'utilisation ---------------------- @@ -27,7 +27,7 @@ voulez donner au dépôt) : Dès lors, le dépôt est publié en _lecture seule_ à l'adresse `https://git.club1.fr/<login>/<repo>`, mais celui-ci est vide pour le -moment. La branche affichée par défaut dans l'interface web est `master`. +moment. La branche affichée par défaut dans l'interface {term}`Web` est `master`. Il est possible de la changer en modifiant le fichier `HEAD` du dépôt. Par exemple pour la remplacer par la branche `main` : @@ -52,10 +52,12 @@ au dépôt : git clone <login>@club1.fr:git/<repo> +```{note} Un avertissement alertera sur le fait que le dépôt ainsi cloné est vide, ce qui est normal : warning: You appear to have cloned an empty repository. +``` Il est désormais possible d'utiliser ce dépôt comme tout autre dépôt {term}`Git`, par exemple : diff --git a/services/mysql.md b/services/mysql.md index 14d19dd..03f444b 100644 --- a/services/mysql.md +++ b/services/mysql.md @@ -2,13 +2,14 @@ Bases de données MySQL ====================== Un accès à MariaDb pourra être ajouté, à partir duquel il est possible de -créer des **bases de données MySQL personnelles**. Une instance de phpMyAdmin -est disponnible à l'adresse suivante : <https://club1.fr/phpmyadmin> +créer des **bases de données MySQL personnelles**. Une interface {term}`Web` +de gestion fournie par [phpMyAdmin](https://fr.wikipedia.org/wiki/PhpMyAdmin) +est disponible à l'adresse suivante : <https://club1.fr/phpmyadmin> Informations de connexion ------------------------- -| champ | valeur | -| ---------------- | ----------- | -| hôte | `localhost` | -| port | `3306` | +| champ | valeur | +| ---------------- | ------------------- | +| hôte | `localhost` | +| port | `3306` (par défaut) | diff --git a/services/rss.md b/services/rss.md index 14ad2fc..38d58ac 100644 --- a/services/rss.md +++ b/services/rss.md @@ -3,7 +3,7 @@ Agrégateur de flux RSS Un agrégateur de flux RSS est fourni par [Tiny Tiny RSS](https://fr.wikipedia.org/wiki/Tiny_Tiny_RSS) (abbrégé TTRSS). -Il est accessible à travers le {term}`client web` intégré se trouvant à l'adresse +Il est accessible à travers le {term}`client Web` intégré se trouvant à l'adresse <https://rss.club1.fr>, mais il est également possible d'y connecter un client natif. @@ -11,7 +11,7 @@ Se connecter avec un client natif --------------------------------- Avant de pouvoir connecter un client natif, il faut activer l'{term}`API` dans -les paramètres du {term}`client web`. Cliquer sur le menu (icone avec les trois +les paramètres du {term}`client Web`. Cliquer sur le menu (icone avec les trois barres en haut à droite) → `Configuration...` → Onglet `Configuration` → Section `Général` → Cocher la case `Activer l'API`. diff --git a/services/ssh.md b/services/ssh.md index 7a80ef7..bb3004a 100644 --- a/services/ssh.md +++ b/services/ssh.md @@ -31,8 +31,10 @@ suivante : echo club1.fr ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIBFQJRiEKM9iywtuvjLD7Wvp6F7VqM6ocuc0Q05LGKU6 >> ~/.ssh/known_hosts +```{tip} Si pour une quelconque raison la comparaison manuelle est préférée, l'empreinte de l'exemple ci-dessus est effectivement celle de club1.fr. +``` Créer une paire de clés de chiffrement -------------------------------------- @@ -50,7 +52,7 @@ le serveur, afin de pouvoir l'utiliser comme méthode d'authentification Informations de connexion ------------------------- -| champ | valeur | -| ---------------- | ---------- | -| hôte | `club1.fr` | -| port | `22` | +| champ | valeur | +| ---------------- | ----------------- | +| hôte | `club1.fr` | +| port | `22` (par défaut) | diff --git a/services/web.md b/services/web.md index 137c200..bf021df 100644 --- a/services/web.md +++ b/services/web.md @@ -1,17 +1,17 @@ -Sites Web -========= +Hébergement de sites Web +======================== -Il existe deux grands types de sites web : les sites _statiques_, +Il existe deux grands types de sites {term}`Web` : les sites _statiques_, constitués de fichiers dont le contenu ne change pas tant qu'ils n'ont pas été modifiés et les sites _dynamiques_, dont les fichiers sont exécutés et peuvent ainsi produire des résultats différents. -Sites web _statiques_ +Sites Web _statiques_ --------------------- L'**espace personnel** dispose d'un dossier spécial `static/` à sa racine. Tous les fichiers et dossiers rangés dedans seront automatiquement publiés -sur le web à l'adresse `https://static.club1.fr`, par exemple : +sur le {term}`Web` à l'adresse `https://static.club1.fr`, par exemple : [`https://static.club1.fr/nicolas/test.html`](https://static.club1.fr/nicolas/test.html) → `/home/nicolas/static/test.html` @@ -29,10 +29,10 @@ ligne suivante. Options -Indexes ``` -Sites web _dynamiques_ +Sites Web _dynamiques_ ---------------------- Il est possible d'ajouter à la demande des **sous-domaines** de `club1.fr` pointant vers **l'un des dossiers** présent dans votre **espace personnel** -pour ainsi créer un site web. Les noms des sous-domaines seront à définir +pour ainsi créer un site {term}`Web`. Les noms des sous-domaines seront à définir ensemble en fonction de leur disponibilité et leur viabilité. |