From f2fc8830d29b31ae6cb5d980644f0020dae21e06 Mon Sep 17 00:00:00 2001 From: n-peugnet Date: Wed, 23 Mar 2022 18:07:13 +0100 Subject: fix some links & add github config for RTD theme --- conf.py | 15 +++++++++++++- ftps.md | 33 ------------------------------ index.rst | 12 +++++------ mysql.md | 15 -------------- services/ftps.md | 35 ++++++++++++++++++++++++++++++++ services/mysql.md | 15 ++++++++++++++ services/ssh.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ services/web.md | 7 +++++++ ssh.md | 58 ----------------------------------------------------- web.md | 7 ------- 10 files changed, 136 insertions(+), 121 deletions(-) delete mode 100644 ftps.md delete mode 100644 mysql.md create mode 100644 services/ftps.md create mode 100644 services/mysql.md create mode 100644 services/ssh.md create mode 100644 services/web.md delete mode 100644 ssh.md delete mode 100644 web.md 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/ftps.md b/ftps.md deleted file mode 100644 index 0f8f01a..0000000 --- a/ftps.md +++ /dev/null @@ -1,33 +0,0 @@ -FTPS (File Transfer Protocol over implicit tlS) -=============================================== - -Bien que [ssh](ssh) puisse aussi être utilisé dans ce but, FTPIS peut être -utile lors du tranfert d'un grand nombre de fichiers depuis et vers le -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). - -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). - -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 -important de vérifier qu'il est bien délivré par `Let's Encrypt`. - -Informations de connexion -------------------------- - -| champ | valeur | -|------------------|--------------------| -| hôte | `club1.fr` | -| port | `990` (par défaut) | -| chiffrement | TLS Implicite | -| authentification | Normale | - 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/mysql.md b/mysql.md deleted file mode 100644 index f621ffd..0000000 --- a/mysql.md +++ /dev/null @@ -1,15 +0,0 @@ -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**. L'identifiant et le mot -de passe seront identiques à ceux du compte FTP. Une instance de phpMyAdmin -est disponnible à l'adresse suivante : - -Informations de connexion -------------------------- - -| champ | valeur | -| ---------------- | ----------- | -| hôte | `localhost` | -| port | `3306` | diff --git a/services/ftps.md b/services/ftps.md new file mode 100644 index 0000000..8c49a4f --- /dev/null +++ b/services/ftps.md @@ -0,0 +1,35 @@ +FTPS (File Transfer Protocol over implicit tlS) +=============================================== + +Bien que [ssh](ssh) puisse aussi être utilisé dans ce but, FTPIS peut être +utile lors du tranfert d'un grand nombre de fichiers depuis et vers le +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][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)][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 +important de vérifier qu'il est bien délivré par `Let's Encrypt`. + +Informations de connexion +------------------------- + +| champ | valeur | +|------------------|--------------------| +| hôte | `club1.fr` | +| port | `990` (par défaut) | +| 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/services/mysql.md b/services/mysql.md new file mode 100644 index 0000000..f621ffd --- /dev/null +++ b/services/mysql.md @@ -0,0 +1,15 @@ +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**. L'identifiant et le mot +de passe seront identiques à ceux du compte FTP. Une instance de phpMyAdmin +est disponnible à l'adresse suivante : + +Informations de connexion +------------------------- + +| champ | valeur | +| ---------------- | ----------- | +| hôte | `localhost` | +| port | `3306` | diff --git a/services/ssh.md b/services/ssh.md new file mode 100644 index 0000000..769f855 --- /dev/null +++ b/services/ssh.md @@ -0,0 +1,60 @@ +SSH (Secure SHell) +================== + +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][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). + + +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][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 +l'empreinte de la clé reçue : + +> The authenticity of host 'club1.fr (***)' can't be established. +> ED25519 key fingerprint is SHA256:t4m5ioK2DGyObdxh3ATIIKnbhm4EhCp1cfgQmogHd58. +> Are you sure you want to continue connecting (yes/no/[fingerprint])? + +Ce n'est pas idéal car il faut comparer manuellement l'empreinte de +l'avertissement avec celle fournie par l'administrateur. À la place, il est +préférable d'ajouter la clé avant le première connexion avec la commande +suivante : + + echo club1.fr ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIBFQJRiEKM9iywtuvjLD7Wvp6F7VqM6ocuc0Q05LGKU6 >> ~/.ssh/known_hosts + +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 +-------------------------------------- + +Pour créer une paire de clé de chiffrement, on utilise la commande suivante. + + ssh-keygen + +La commande qui suit va permettre d'envoyer la partie publique de la clé vers +le serveur, afin de pouvoir l'utiliser comme méthode d'authentification. +(Remplacer `` par votre identifiant) + + ssh-copy-id -i ~/.ssh/id_rsa @club1.fr + +Informations de connexion +------------------------- + +| champ | valeur | +| ---------------- | ---------- | +| 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/services/web.md b/services/web.md new file mode 100644 index 0000000..5ee129d --- /dev/null +++ b/services/web.md @@ -0,0 +1,7 @@ +Sites Web +========= + +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 +ensemble en fonction de leur disponibilité et leur viabilité. diff --git a/ssh.md b/ssh.md deleted file mode 100644 index 4a8e925..0000000 --- a/ssh.md +++ /dev/null @@ -1,58 +0,0 @@ -SSH (Secure SHell) -================== - -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 -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). - - -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) -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 -l'empreinte de la clé reçue : - -> The authenticity of host 'club1.fr (***)' can't be established. -> ED25519 key fingerprint is SHA256:t4m5ioK2DGyObdxh3ATIIKnbhm4EhCp1cfgQmogHd58. -> Are you sure you want to continue connecting (yes/no/[fingerprint])? - -Ce n'est pas idéal car il faut comparer manuellement l'empreinte de -l'avertissement avec celle fournie par l'administrateur. À la place, il est -préférable d'ajouter la clé avant le première connexion avec la commande -suivante : - - echo club1.fr ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIBFQJRiEKM9iywtuvjLD7Wvp6F7VqM6ocuc0Q05LGKU6 >> ~/.ssh/known_hosts - -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 --------------------------------------- - -Pour créer une paire de clé de chiffrement, on utilise la commande suivante. - - ssh-keygen - -La commande qui suit va permettre d'envoyer la partie publique de la clé vers -le serveur, afin de pouvoir l'utiliser comme méthode d'authentification. -(Remplacer `` par votre identifiant) - - ssh-copy-id -i ~/.ssh/id_rsa @club1.fr - -Informations de connexion -------------------------- - -| champ | valeur | -| ---------------- | ---------- | -| hôte | `club1.fr` | -| port | `22` | - diff --git a/web.md b/web.md deleted file mode 100644 index 5ee129d..0000000 --- a/web.md +++ /dev/null @@ -1,7 +0,0 @@ -Sites Web -========= - -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 -ensemble en fonction de leur disponibilité et leur viabilité. -- cgit v1.2.3