aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorn-peugnet <n.peugnet@free.fr>2022-03-23 18:07:13 +0100
committern-peugnet <n.peugnet@free.fr>2022-03-23 18:07:13 +0100
commitf2fc8830d29b31ae6cb5d980644f0020dae21e06 (patch)
tree632bab3fb6f51388779c8259c9854d8c924636fd
parentf6777b48cc37c54f80f04966b640bf3a74badfe1 (diff)
downloadclub1-docs-f2fc8830d29b31ae6cb5d980644f0020dae21e06.tar.gz
club1-docs-f2fc8830d29b31ae6cb5d980644f0020dae21e06.zip
fix some links & add github config for RTD theme
-rw-r--r--conf.py15
-rw-r--r--index.rst12
-rw-r--r--services/ftps.md (renamed from ftps.md)8
-rw-r--r--services/mysql.md (renamed from mysql.md)0
-rw-r--r--services/ssh.md (renamed from ssh.md)6
-rw-r--r--services/web.md (renamed from web.md)0
6 files changed, 28 insertions, 13 deletions
diff --git a/conf.py b/conf.py
index 37ee5e4..7637981 100644
--- a/conf.py
+++ b/conf.py
@@ -17,7 +17,7 @@
# -- Project information -----------------------------------------------------
-project = 'Docs CLUB1'
+project = 'Documentation CLUB1'
copyright = '2022, Nicolas PEUGNET'
author = 'Nicolas PEUGNET'
@@ -59,6 +59,19 @@ exclude_patterns = [
#
html_theme = 'sphinx_rtd_theme'
+html_context = {
+ 'display_github': True,
+ 'github_user': 'club-1',
+ 'github_repo': 'docs',
+ 'github_version': 'main/',
+}
+
+html_theme_options = {
+ 'prev_next_buttons_location': 'bottom',
+ 'style_external_links': True,
+ 'vcs_pageview_mode': 'edit',
+}
+
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
diff --git a/index.rst b/index.rst
index 90bc0fa..567a3d6 100644
--- a/index.rst
+++ b/index.rst
@@ -13,11 +13,9 @@ nombre de protocoles, fournissant différents services.
.. toctree::
:maxdepth: 2
- :caption: Services:
-
- ftps
- ssh
- web
- mysql
-
+ :caption: Services :
+ services/ftps
+ services/ssh
+ services/web
+ services/mysql
diff --git a/ftps.md b/services/ftps.md
index 0f8f01a..8c49a4f 100644
--- a/ftps.md
+++ b/services/ftps.md
@@ -7,15 +7,14 @@ serveur CLUB1.
Le compte FTP est constitué d'un **identifiant** et d'un **mot de passe**,
il permet d'accéder à votre *espace personnel* grâce à des logiciels comme
-[FileZilla](https://filezilla-project.org/download.php?type=client)
-(attention l'installeur windows comprend des bundlewares).
+[FileZilla][filezilla] (attention l'installeur windows comprend des bundlewares).
Sécurité
--------
Le serveur FTP est configuré pour ne recevoir que des connexions chiffrés
avec TLS pour éviter d'envoyer des mots de passe en clair. Cette fonctionnalité
-s'appelle [FTPS (FTP over implicit TLS)](https://en.wikipedia.org/wiki/FTPS#Implicit).
+s'appelle [FTPS (FTP over implicit TLS)][wiki-ftps].
Un certificat est utilisé pour prouver l'authenticité de la clé du serveur.
Si un message demande d'approuver le certificat lors de la connexion, il est
@@ -31,3 +30,6 @@ Informations de connexion
| chiffrement | TLS Implicite |
| authentification | Normale |
+
+[filezilla]: https://filezilla-project.org/download.php?type=client
+[wiki-ftps]: https://fr.wikipedia.org/wiki/File_Transfer_Protocol_Secure#FTP_avec_chiffrement_implicite
diff --git a/mysql.md b/services/mysql.md
index f621ffd..f621ffd 100644
--- a/mysql.md
+++ b/services/mysql.md
diff --git a/ssh.md b/services/ssh.md
index 4a8e925..769f855 100644
--- a/ssh.md
+++ b/services/ssh.md
@@ -5,7 +5,7 @@ SSH permet de se connecter à distance au serveur CLUB1. L'accès SSH peut se
révéler très utile pour les **utilisateurs avancés** aussi bien que pour les
**débutants**.
-Dans cette section [OpenSSH](https://fr.wikipedia.org/wiki/OpenSSH) sera
+Dans cette section [OpenSSH][wiki-openssh] sera
utilisé. Comme il s'agit dans logiciel en *ligne de commande*, il est
nécessaire d'ouvrir une fenêtre de terminal (powershell sur windows).
@@ -15,7 +15,7 @@ Première connexion
La première connexion est critique car c'est lors de celle-ci que se fait
l'échange des clés. Pour éviter de subir une
-[attaque de l'homme du milieu](https://fr.wikipedia.org/wiki/Attaque_de_l%27homme_du_milieu)
+[attaque de l'homme du milieu][wiki-mitm]
il nous faut être sûr d'avoir reçu la bonne clé lors de cet échange.
Pour résoudre ce problème, OpenSSH affiche un avertissement contenant
@@ -56,3 +56,5 @@ Informations de connexion
| hôte | `club1.fr` |
| port | `22` |
+[wiki-openssh]: https://fr.wikipedia.org/wiki/OpenSSH
+[wiki-mitm]: https://fr.wikipedia.org/wiki/Attaque_de_l%27homme_du_milieu
diff --git a/web.md b/services/web.md
index 5ee129d..5ee129d 100644
--- a/web.md
+++ b/services/web.md