From ff4f0700685e1e5e9ca4145771d3fd029a31f1fe Mon Sep 17 00:00:00 2001 From: n-peugnet Date: Tue, 29 Mar 2022 19:51:41 +0200 Subject: feat: big reorganization tu use a single root toctree Mainly to get a correct LaTeX pdf. But also for a simpler organization. --- admin/aliases.md | 49 -------- general.md | 61 ++++++++++ index.md | 82 +------------ interne/aliases.md | 49 ++++++++ interne/index.md | 10 ++ locales/en/LC_MESSAGES/package.po | 238 +++++++++++++++++++------------------- locales/package.pot | 204 ++++++++++++++++---------------- services/index.md | 17 +++ 8 files changed, 365 insertions(+), 345 deletions(-) delete mode 100644 admin/aliases.md create mode 100644 general.md create mode 100644 interne/aliases.md create mode 100644 interne/index.md create mode 100644 services/index.md diff --git a/admin/aliases.md b/admin/aliases.md deleted file mode 100644 index 4dff3f3..0000000 --- a/admin/aliases.md +++ /dev/null @@ -1,49 +0,0 @@ -Gestion des alias email -======================= - -Ce tutoriel est réservé aux utilisateurs faisant partie du groupe unix `aliases`. -Il décrit les actions que peuvent accomplir ces utilisateurs. - -Modifier le fichier de configuration des aliases ------------------------------------------------- - -Ouvrir le fichier `/etc/aliases` avec votre éditeur de texte en CLI favori -(`nano`, `vim`, etc.). -Il doit ressembler approximativement à ceci : - -```Makefile -# See man 5 aliases for format -postmaster: root -root: nicolas -contact: nicolas,vincent,guilhem,audrey -alert: nicolas,vincent,guilhem -matrix-synapse: /dev/null -jellyfin: /dev/null -``` - -### Ajouter ou supprimer un utiliseteur d'un alias - -Il suffit d'écrire ou d'effacer l'identifiant de l'utilisateur choisi de la -liste se trouvant après le nom de l'alias. - -### Ajouter ou supprimer un alias - -Il est possible d'ajouter autant d'alias que voulu a ajoutant une nouvelle ligne -au ficher, en suivant la [syntaxe d'alias de postfix](http://www.postfix.org/aliases.5.html) : - -``` -: [,...] -``` - -Pour supprimer un alias, il suffit de supprimer ou commenter (avec `#`) la ligne -correspondante. - -Soumettre les modifications ---------------------------- - -Après avoir sauvegardé le fichier, il est nécessaire de regénérer la base de -donnée (`/etc/aliases.db`) en lançant la commande suivante : - -``` -sudo newaliases -``` diff --git a/general.md b/general.md new file mode 100644 index 0000000..ff87bf5 --- /dev/null +++ b/general.md @@ -0,0 +1,61 @@ +Informations générales +====================== + +Demandes et Incidents +--------------------- + +Pour toute demande ou incident, veuillez [créer un ticket (_issue_)](https://github.com/club-1/hosting/issues) +sur GitHub (vous devrez pour celà créer un compte), en choisissant entre demande +(_request_) ou incident (_problem_) en fonction de la nature du ticket. +Si il s'agit d'une demande impersonnelle, merci de **vérifier** qu'il n'éxiste pas +déjà une demande similaire à l'aide de la barre de recherche. + + +Infos sur le serveur +-------------------- + +### Matériel et infrastructure + +Le serveur est localisé en France à Pantin. Il est relié à internet par fibre +optique avec un [débit montant de 200Mb/s en moyenne](https://www.nperf.com/r/338260996-nDOmVdkc). + +### Système d'exploitation + +Le serveur tourne sur la dernière version **LTS d'_ubuntu server_ (20.04)** et +est mis à jour régulièrement. + +### Logiciels et bibliothèques installés + +Un certain nombre de logiciels et de bibliothèques sont déjà installés. +En voici une liste _non-exhaustive_ : + +- Apache 2.4 +- MariaDb 10.5 +- PHP 7.4 +- Python 3.8 +- NodeJs 10.19 +- Composer 1.10 +- pip 20.0 +- npm 7.5.2 +- phpMyAdmin 4.9 +- git 2.25 +- ... + +Si vous souhaitez qu'un logiciel supplémentaire soit installé, merci de +**vérifier** dans un premier temps qu'il n'est pas déjà présent, puis, dans +le cas contraire, de **créer un ticket** comme expliqué [ci-dessus](#demandes-et-incidents). + +### Disponibilité + +Afin de garantir un certaine disponibilité, le serveur ainsi que les équipements +réseaux sont alimentés par une _UPS_. Cependant, la redondance n'étant pas +présente à tous les niveaux, le serveur pourrait être inaccessible pendant +de courts laps de temps, par exemple lors d'une mise à jour du noyau. +Cela dit, une disponibilité effective **supérieure à 90%** devrait pouvoir être +assurée. + +Politique et vie privée +----------------------- + +Aucune des données que vous stockez dans votre espace personnel de sera +divulguée ni utilisée à des fins lucratives et ce même sous la menace. diff --git a/index.md b/index.md index 600055c..04c163f 100644 --- a/index.md +++ b/index.md @@ -1,87 +1,11 @@ Documentation de l'hébergement CLUB1 ==================================== -L'hébergement CLUB1 est basé sur la mise à disposition d'un *espace personnel*. -Il s'agit d'un espace de stockage sur le serveur, accessible via un certain -nombre de protocoles, fournissant différents services. - - -```{toctree} ---- -maxdepth: 2 -caption: Services ---- -services/ftps -services/ssh -services/web -services/mysql -``` - -Demandes et Incidents ---------------------- - -Pour toute demande ou incident, veuillez [créer un ticket (_issue_)](https://github.com/club-1/hosting/issues) -sur GitHub (vous devrez pour celà créer un compte), en choisissant entre demande -(_request_) ou incident (_problem_) en fonction de la nature du ticket. -Si il s'agit d'une demande impersonnelle, merci de **vérifier** qu'il n'éxiste pas -déjà une demande similaire à l'aide de la barre de recherche. - - -Infos sur le serveur --------------------- - -### Matériel et infrastructure - -Le serveur est localisé en France à Pantin. Il est relié à internet par fibre -optique avec un [débit montant de 200Mb/s en moyenne](https://www.nperf.com/r/338260996-nDOmVdkc). - -### Système d'exploitation - -Le serveur tourne sur la dernière version **LTS d'_ubuntu server_ (20.04)** et -est mis à jour régulièrement. - -### Logiciels et bibliothèques installés - -Un certain nombre de logiciels et de bibliothèques sont déjà installés. -En voici une liste _non-exhaustive_ : - -- Apache 2.4 -- MariaDb 10.5 -- PHP 7.4 -- Python 3.8 -- NodeJs 10.19 -- Composer 1.10 -- pip 20.0 -- npm 7.5.2 -- phpMyAdmin 4.9 -- git 2.25 -- ... - -Si vous souhaitez qu'un logiciel supplémentaire soit installé, merci de -**vérifier** dans un premier temps qu'il n'est pas déjà présent, puis, dans -le cas contraire, de **créer un ticket** comme expliqué [ci-dessus](#demandes-et-incidents). - -### Disponibilité - -Afin de garantir un certaine disponibilité, le serveur ainsi que les équipements -réseaux sont alimentés par une _UPS_. Cependant, la redondance n'étant pas -présente à tous les niveaux, le serveur pourrait être inaccessible pendant -de courts laps de temps, par exemple lors d'une mise à jour du noyau. -Cela dit, une disponibilité effective **supérieure à 90%** devrait pouvoir être -assurée. - -Politique et vie privée ------------------------ - -Aucune des données que vous stockez dans votre espace personnel de sera -divulguée ni utilisée à des fins lucratives et ce même sous la menace. - - ```{toctree} --- maxdepth: 2 -caption: Documentation interne --- -README -admin/aliases +general +services/index +interne/index ``` diff --git a/interne/aliases.md b/interne/aliases.md new file mode 100644 index 0000000..4dff3f3 --- /dev/null +++ b/interne/aliases.md @@ -0,0 +1,49 @@ +Gestion des alias email +======================= + +Ce tutoriel est réservé aux utilisateurs faisant partie du groupe unix `aliases`. +Il décrit les actions que peuvent accomplir ces utilisateurs. + +Modifier le fichier de configuration des aliases +------------------------------------------------ + +Ouvrir le fichier `/etc/aliases` avec votre éditeur de texte en CLI favori +(`nano`, `vim`, etc.). +Il doit ressembler approximativement à ceci : + +```Makefile +# See man 5 aliases for format +postmaster: root +root: nicolas +contact: nicolas,vincent,guilhem,audrey +alert: nicolas,vincent,guilhem +matrix-synapse: /dev/null +jellyfin: /dev/null +``` + +### Ajouter ou supprimer un utiliseteur d'un alias + +Il suffit d'écrire ou d'effacer l'identifiant de l'utilisateur choisi de la +liste se trouvant après le nom de l'alias. + +### Ajouter ou supprimer un alias + +Il est possible d'ajouter autant d'alias que voulu a ajoutant une nouvelle ligne +au ficher, en suivant la [syntaxe d'alias de postfix](http://www.postfix.org/aliases.5.html) : + +``` +: [,...] +``` + +Pour supprimer un alias, il suffit de supprimer ou commenter (avec `#`) la ligne +correspondante. + +Soumettre les modifications +--------------------------- + +Après avoir sauvegardé le fichier, il est nécessaire de regénérer la base de +donnée (`/etc/aliases.db`) en lançant la commande suivante : + +``` +sudo newaliases +``` diff --git a/interne/index.md b/interne/index.md new file mode 100644 index 0000000..f87272b --- /dev/null +++ b/interne/index.md @@ -0,0 +1,10 @@ +Documentation interne +===================== + +```{toctree} +--- +maxdepth: 2 +--- +/README +aliases +``` diff --git a/locales/en/LC_MESSAGES/package.po b/locales/en/LC_MESSAGES/package.po index c0d4991..001048c 100644 --- a/locales/en/LC_MESSAGES/package.po +++ b/locales/en/LC_MESSAGES/package.po @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: Hébergement CLUB1 main\n" "Report-Msgid-Bugs-To: nicolas@club1.fr\n" -"POT-Creation-Date: 2022-03-29 15:31+0200\n" +"POT-Creation-Date: 2022-03-29 19:51+0200\n" "PO-Revision-Date: 2022-03-27 18:00+0000\n" "Last-Translator: Nicolas Peugnet \n" "Language-Team: English \n" "Language-Team: LANGUAGE \n" @@ -196,87 +196,15 @@ msgid "" "commentaire suivant juste au dessus du la ligne `msgid \"...\"` :" msgstr "" -#: ../../admin/aliases.md:1 -msgid "Gestion des alias email" -msgstr "" - -#: ../../admin/aliases.md:4 -msgid "" -"Ce tutoriel est réservé aux utilisateurs faisant partie du groupe unix " -"`aliases`. Il décrit les actions que peuvent accomplir ces utilisateurs." -msgstr "" - -#: ../../admin/aliases.md:7 -msgid "Modifier le fichier de configuration des aliases" -msgstr "" - -#: ../../admin/aliases.md:10 -msgid "" -"Ouvrir le fichier `/etc/aliases` avec votre éditeur de texte en CLI favori " -"(`nano`, `vim`, etc.). Il doit ressembler approximativement à ceci :" -msgstr "" - -#: ../../admin/aliases.md:24 -msgid "Ajouter ou supprimer un utiliseteur d'un alias" -msgstr "" - -#: ../../admin/aliases.md:26 -msgid "" -"Il suffit d'écrire ou d'effacer l'identifiant de l'utilisateur choisi de la " -"liste se trouvant après le nom de l'alias." -msgstr "" - -#: ../../admin/aliases.md:29 -msgid "Ajouter ou supprimer un alias" -msgstr "" - -#: ../../admin/aliases.md:31 -msgid "" -"Il est possible d'ajouter autant d'alias que voulu a ajoutant une nouvelle " -"ligne au ficher, en suivant la [syntaxe d'alias de postfix](http://www." -"postfix.org/aliases.5.html) :" +#: ../../general.md:1 +msgid "Informations générales" msgstr "" -#: ../../admin/aliases.md:38 -msgid "" -"Pour supprimer un alias, il suffit de supprimer ou commenter (avec `#`) la " -"ligne correspondante." -msgstr "" - -#: ../../admin/aliases.md:41 -msgid "Soumettre les modifications" -msgstr "" - -#: ../../admin/aliases.md:44 -msgid "" -"Après avoir sauvegardé le fichier, il est nécessaire de regénérer la base de " -"donnée (`/etc/aliases.db`) en lançant la commande suivante :" -msgstr "" - -#: ../../index.md:9 -msgid "Services" -msgstr "" - -#: ../../index.md:80 -msgid "Documentation interne" -msgstr "" - -#: ../../index.md:1 -msgid "Documentation de l'hébergement CLUB1" -msgstr "" - -#: ../../index.md:4 -msgid "" -"L'hébergement CLUB1 est basé sur la mise à disposition d'un *espace " -"personnel*. Il s'agit d'un espace de stockage sur le serveur, accessible via " -"un certain nombre de protocoles, fournissant différents services." -msgstr "" - -#: ../../index.md:20 +#: ../../general.md:4 msgid "Demandes et Incidents" msgstr "" -#: ../../index.md:23 +#: ../../general.md:7 msgid "" "Pour toute demande ou incident, veuillez [créer un ticket (_issue_)](https://" "github.com/club-1/hosting/issues) sur GitHub (vous devrez pour celà créer un " @@ -286,86 +214,86 @@ msgid "" "de la barre de recherche." msgstr "" -#: ../../index.md:30 +#: ../../general.md:14 msgid "Infos sur le serveur" msgstr "" -#: ../../index.md:33 +#: ../../general.md:17 msgid "Matériel et infrastructure" msgstr "" -#: ../../index.md:35 +#: ../../general.md:19 msgid "" "Le serveur est localisé en France à Pantin. Il est relié à internet par " "fibre optique avec un [débit montant de 200Mb/s en moyenne](https://www." "nperf.com/r/338260996-nDOmVdkc)." msgstr "" -#: ../../index.md:38 +#: ../../general.md:22 msgid "Système d'exploitation" msgstr "" -#: ../../index.md:40 +#: ../../general.md:24 msgid "" "Le serveur tourne sur la dernière version **LTS d'_ubuntu server_ (20.04)** " "et est mis à jour régulièrement." msgstr "" -#: ../../index.md:43 +#: ../../general.md:27 msgid "Logiciels et bibliothèques installés" msgstr "" -#: ../../index.md:45 +#: ../../general.md:29 msgid "" "Un certain nombre de logiciels et de bibliothèques sont déjà installés. En " "voici une liste _non-exhaustive_ :" msgstr "" -#: ../../index.md:48 +#: ../../general.md:32 msgid "Apache 2.4" msgstr "" -#: ../../index.md:49 +#: ../../general.md:33 msgid "MariaDb 10.5" msgstr "" -#: ../../index.md:50 +#: ../../general.md:34 msgid "PHP 7.4" msgstr "" -#: ../../index.md:51 +#: ../../general.md:35 msgid "Python 3.8" msgstr "" -#: ../../index.md:52 +#: ../../general.md:36 msgid "NodeJs 10.19" msgstr "" -#: ../../index.md:53 +#: ../../general.md:37 msgid "Composer 1.10" msgstr "" -#: ../../index.md:54 +#: ../../general.md:38 msgid "pip 20.0" msgstr "" -#: ../../index.md:55 +#: ../../general.md:39 msgid "npm 7.5.2" msgstr "" -#: ../../index.md:56 +#: ../../general.md:40 msgid "phpMyAdmin 4.9" msgstr "" -#: ../../index.md:57 +#: ../../general.md:41 msgid "git 2.25" msgstr "" -#: ../../index.md:58 +#: ../../general.md:42 msgid "..." msgstr "" -#: ../../index.md:60 +#: ../../general.md:44 msgid "" "Si vous souhaitez qu'un logiciel supplémentaire soit installé, merci de " "**vérifier** dans un premier temps qu'il n'est pas déjà présent, puis, dans " @@ -373,11 +301,11 @@ msgid "" "(#demandes-et-incidents)." msgstr "" -#: ../../index.md:64 +#: ../../general.md:48 msgid "Disponibilité" msgstr "" -#: ../../index.md:66 +#: ../../general.md:50 msgid "" "Afin de garantir un certaine disponibilité, le serveur ainsi que les " "équipements réseaux sont alimentés par une _UPS_. Cependant, la redondance " @@ -387,16 +315,81 @@ msgid "" "devrait pouvoir être assurée." msgstr "" -#: ../../index.md:73 +#: ../../general.md:57 msgid "Politique et vie privée" msgstr "" -#: ../../index.md:76 +#: ../../general.md:60 msgid "" "Aucune des données que vous stockez dans votre espace personnel de sera " "divulguée ni utilisée à des fins lucratives et ce même sous la menace." msgstr "" +#: ../../index.md:1 +msgid "Documentation de l'hébergement CLUB1" +msgstr "" + +#: ../../interne/aliases.md:1 +msgid "Gestion des alias email" +msgstr "" + +#: ../../interne/aliases.md:4 +msgid "" +"Ce tutoriel est réservé aux utilisateurs faisant partie du groupe unix " +"`aliases`. Il décrit les actions que peuvent accomplir ces utilisateurs." +msgstr "" + +#: ../../interne/aliases.md:7 +msgid "Modifier le fichier de configuration des aliases" +msgstr "" + +#: ../../interne/aliases.md:10 +msgid "" +"Ouvrir le fichier `/etc/aliases` avec votre éditeur de texte en CLI favori " +"(`nano`, `vim`, etc.). Il doit ressembler approximativement à ceci :" +msgstr "" + +#: ../../interne/aliases.md:24 +msgid "Ajouter ou supprimer un utiliseteur d'un alias" +msgstr "" + +#: ../../interne/aliases.md:26 +msgid "" +"Il suffit d'écrire ou d'effacer l'identifiant de l'utilisateur choisi de la " +"liste se trouvant après le nom de l'alias." +msgstr "" + +#: ../../interne/aliases.md:29 +msgid "Ajouter ou supprimer un alias" +msgstr "" + +#: ../../interne/aliases.md:31 +msgid "" +"Il est possible d'ajouter autant d'alias que voulu a ajoutant une nouvelle " +"ligne au ficher, en suivant la [syntaxe d'alias de postfix](http://www." +"postfix.org/aliases.5.html) :" +msgstr "" + +#: ../../interne/aliases.md:38 +msgid "" +"Pour supprimer un alias, il suffit de supprimer ou commenter (avec `#`) la " +"ligne correspondante." +msgstr "" + +#: ../../interne/aliases.md:41 +msgid "Soumettre les modifications" +msgstr "" + +#: ../../interne/aliases.md:44 +msgid "" +"Après avoir sauvegardé le fichier, il est nécessaire de regénérer la base de " +"donnée (`/etc/aliases.db`) en lançant la commande suivante :" +msgstr "" + +#: ../../interne/index.md:1 +msgid "Documentation interne" +msgstr "" + #: ../../services/ftps.md:1 msgid "FTPS (File Transfer Protocol Secure)" msgstr "" @@ -480,6 +473,17 @@ msgstr "" msgid "Normale" msgstr "" +#: ../../services/index.md:1 +msgid "Services" +msgstr "" + +#: ../../services/index.md:4 +msgid "" +"L'hébergement CLUB1 est basé sur la mise à disposition d'un *espace " +"personnel*. Il s'agit d'un espace de stockage sur le serveur, accessible via " +"un certain nombre de protocoles, fournissant différents services." +msgstr "" + #: ../../services/mysql.md:1 msgid "Bases de données MySQL" msgstr "" diff --git a/services/index.md b/services/index.md new file mode 100644 index 0000000..21ee7d8 --- /dev/null +++ b/services/index.md @@ -0,0 +1,17 @@ +Services +======== + +L'hébergement CLUB1 est basé sur la mise à disposition d'un *espace personnel*. +Il s'agit d'un espace de stockage sur le serveur, accessible via un certain +nombre de protocoles, fournissant différents services. + + +```{toctree} +--- +maxdepth: 2 +--- +ftps +ssh +web +mysql +``` -- cgit v1.2.3