Skip to Content

Modifications pour le document Mettre en place un sous-domaine

Modifié par Gaetan RETEL le 2025/10/05 00:35
Depuis la version 3.16
modifié par Clément AUBIN
sur 2021/04/18 09:40
Commentaire de modification : Il n'y a aucun commentaire pour cette version
À la version 6.1
modifié par Clément AUBIN
sur 2021/04/18 13:55
Commentaire de modification : Il n'y a aucun commentaire pour cette version

Résumé

Détails

Propriétés de la Page
Contenu
... ... @@ -2,9 +2,9 @@
2 2  
3 3  {{toc/}}
4 4  
5 -=Idée générale=
5 += Idée générale =
6 6  
7 -Avant de suivre les étapes de mise en place, c’est intéressant de comprendre ce qu’on va faire ^^.
7 +Avant de suivre les étapes de mise en place, c’est intéressant de comprendre ce qu’on va faire ^^.^^
8 8  
9 9  Dans l'infra d'ATILLA, les connexions à un service web (members.atilla.org, learn.atilla.org, …) passent en grande majorité par Bill, qui acte comme d'un frontal web : c’est lui qui réceptionne les connexions HTTP(s) et qui les renvoie aux bons services internes par la suite. On dit également que Bill joue le rôle de //reverse-proxy//.
10 10  
... ... @@ -12,13 +12,14 @@
12 12  
13 13  [[image:reverse-proxy-arch.png]]
14 14  
15 -En pratique, Bill dispose d'un serveur Nginx, qui va avoir réceptionner toute requête HTTP(s) sur un des sites d'ATILLA et qui transfère cette requête à la VM qui héberge le service correspondant.
15 +En pratique, Bill dispose d'un serveur Nginx, qui va réceptionner toute requête HTTP(s) sur un des sites d'ATILLA et qui transfère cette requête à la VM qui héberge le service correspondant.
16 16  
17 -=Enregistrement du sous-domaine=
17 += Enregistrement du sous-domaine =
18 18  
19 19  La première chose à faire est de déclarer au monde que le domaine sur lequel vous souhaitez déployer votre service existe. Il n’y a pas de convention à proprement parler sur le choix du sous-domaine. Si vous déployez un service de gestion de tickets (par exemple, GLPI), le domaine auquel ce service pourra être accessible peut très bien être ##glpi.atilla.org## ou même ##tickets.atilla.org##.
20 20  
21 21  Pour déclarer ce domaine, rendez-vous sur la machine qui sert de DNS dans l’infra (aujourd’hui, il s’agit de Bill). Deux fichiers devront être édités :
22 +
22 22  * ##/etc/bind/internal/db.atilla.org## : les entrées DNS qui sont exposées à tous les utilisateurs au sein du réseau d’ATILLA et de l’EISTI
23 23  * ##/etc/bind/external/db.atilla.org## : les entrées DNS qui sont exposées à tous les utilisateurs venant de l’extérieur
24 24  
... ... @@ -42,7 +42,7 @@
42 42  Lorsqu’on fait une modification dans une configuration DNS, il y a toujours un temps dit de "propagation", pendant lequel l’entrée qui a été déclarée n’est pas tout de suite accessible par tout le monde. Cela peut prendre jusqu’à 24h pour qu’une entrée soit réellement accessible par tous. Cela est également vrai lorsqu’on modifie ou supprime une entrée.
43 43  {{/warning}}
44 44  
45 -=Mise en place des certificats SSL=
46 += Mise en place des certificats SSL =
46 46  
47 47  Maintenant qu’on a notre domaine, on va pouvoir récupérer des certificats SSL nous permettant de mettre en place le HTTPs sur ce domaine.
48 48  
... ... @@ -58,7 +58,7 @@
58 58  
59 59  Pour la demande du nouveau certificat, utilisez la commande suivante. Lorsque certbot demande quelle méthode de vérification utiliser pour générer le certificat, choisissez //Spin-up a temporary webserver//.
60 60  
61 -{{code language="none"}}
62 +{{code language="shell"}}
62 62  systemctl stop nginx && certbot certonly -d monservice.atilla.org && systemctl start nginx
63 63  {{/code}}
64 64  
... ... @@ -66,19 +66,19 @@
66 66  
67 67  Si vous n’avez pas ce genre de message, avant de démarrer tout diagnostique, assurez-vous de bien redémarrer le serveur Nginx, pour éviter toute interruption de service trop longue :
68 68  
69 -{{code language="none"}}
70 +{{code language="shell"}}
70 70  systemctl start nginx
71 71  ## Pour vérifier que tout va bien
72 72  systemctl status nginx
73 73  {{/code}}
74 74  
75 -=Mise en place de la configuration Nginx=
76 += Mise en place de la configuration Nginx =
76 76  
77 77  Finalement, on va devoir mettre en place la configuration qui va tout lier ensemble, c’est elle qui va indiquer que, lorsqu’un utilisateur se connecte au service, on utilisera le certificat SSL qui a été généré plus haut, et on enverra les connexions à la machine voulue.
78 78  
79 -==Méthode manuelle==
80 +== Méthode manuelle ==
80 80  
81 -===Création de la configuration===
82 +=== Création de la configuration ===
82 82  
83 83  On va créer la configuration d’Nginx dans le dossier ##/etc/nginx/sites-available##. Par convention, le nom du fichier de configuration va correspondre au nom du domaine sur lequel on expose le service. Dans notre cas, il s’agira de ##monservice.atilla.org##.
84 84  
... ... @@ -86,40 +86,120 @@
86 86  
87 87  Voici à peu près ce à quoi doit ressembler la configuration. Attention : il est possible que cela change au fil du temps et que le contenu de ce tuto n’ait pas été mis à jour :).
88 88  
89 -{{code language="none"}}
90 +{{code language="nginx"}}
90 90  server {
91 - listen 80;
92 - server_name monservice.atilla.org;
93 - return 301 https://monservice.atilla.org$request_uri;
92 + listen 80;
93 + server_name monservice.atilla.org;
94 + return 301 https://monservice.atilla.org$request_uri;
94 94  }
95 95  
96 96  server {
97 - listen 443 ssl http2;
98 + listen 443 ssl http2;
98 98  
99 - server_name monservice.atilla.org;
100 + server_name monservice.atilla.org;
100 100  
101 - ssl on;
102 - ssl_certificate_key /etc/letsencrypt/live/monservice.atilla.org/privkey.pem;
103 - ssl_trusted_certificate /etc/letsencrypt/live/monservice.atilla.org/chain.pem;
104 - ssl_certificate /etc/letsencrypt/live/monservice.atilla.org/fullchain.pem;
102 + ssl on;
103 + ssl_certificate_key /etc/letsencrypt/live/monservice.atilla.org/privkey.pem;
104 + ssl_trusted_certificate /etc/letsencrypt/live/monservice.atilla.org/chain.pem;
105 + ssl_certificate /etc/letsencrypt/live/monservice.atilla.org/fullchain.pem;
105 105  
106 - access_log /var/log/nginx/monservice.atilla.org/access.log;
107 - error_log /var/log/nginx/monservice.atilla.org/error.log;
107 + access_log /var/log/nginx/monservice.atilla.org/access.log;
108 + error_log /var/log/nginx/monservice.atilla.org/error.log;
108 108  
109 - location / {
110 - proxy_set_header Host $host;
111 - proxy_set_header X-Forwarded-For $remote_addr;
112 - proxy_pass http://monservice-prod.prod.infra.atilla.org/;
113 - }
110 + location / {
111 + proxy_set_header Host $host;
112 + proxy_set_header X-Forwarded-For $remote_addr;
113 + proxy_pass http://monservice-prod.prod.infra.atilla.org/;
114 + }
114 114  }
115 115  {{/code}}
116 116  
117 -===Création du dossier de logs===
118 +Voici ci-après une description rapide des contenus de ce fichier.
118 118  
119 -===Activation de la configuration Nginx===
120 +On commece par le premier bloc ##server##, celui-ci est très simple et concis, son job, c'est de rediriger tout le traffic HTTP qui arrive sur monservice.atilla.org en HTTPs.
120 120  
121 -==Méthode plus ou moins automatique==
122 +{{code language="nginx"}}
123 +server {
124 + # On écoute sur le port 80 (le port utilisé par défaut avec HTTP)
125 + listen 80;
126 + # On répond aux requêtes qui pointent vers le domaine monservice.atilla.org
127 + server_name monservice.atilla.org;
128 + # On redirige chaque requête vers son équivalent HTTPs
129 + return 301 https://monservice.atilla.org$request_uri;
130 +}
131 +{{/code}}
122 122  
133 +Le second bloc ##server## permet de définir comment va être géré le traffic HTTPs, c'est ici qu'on a la plupart de la configuration importante.
134 +
135 +{{code language="nginx"}}
136 +server {
137 + # On écoute sur le port 443, qui est celui par défaut pour le HTTPs.
138 + # Les deux autres attributs ssl et http2 indiquent :
139 + # * Qu'on va chiffrer la connexion avec SSL (le principe du HTTPs)
140 + # * Qu'on supporte le protocole HTTP/2
141 + listen 443 ssl http2;
142 +
143 + # Comme avant, on répond aux requêtes qui pointent vers le domaine monservice.atilla.org
144 + server_name monservice.atilla.org;
145 +
146 + # On indique encore une fois qu'on va utiliser le SSL, et on fournit les fichiers qui
147 + # sont nécessaires pour authentifier le serveur et chiffrer la connexion.
148 + ssl on;
149 + ssl_certificate_key /etc/letsencrypt/live/monservice.atilla.org/privkey.pem;
150 + ssl_trusted_certificate /etc/letsencrypt/live/monservice.atilla.org/chain.pem;
151 + ssl_certificate /etc/letsencrypt/live/monservice.atilla.org/fullchain.pem;
152 +
153 + # On configure l'emplacement des logs
154 + access_log /var/log/nginx/monservice.atilla.org/access.log;
155 + error_log /var/log/nginx/monservice.atilla.org/error.log;
156 +
157 + # C'est ici que la "magie" opère :)
158 + # La directive proxy_pass nous permet de rediriger tout le traffic vers la machine virtuelle qui correspond
159 + # Les directives proxy_set_header permettent d'ajouter des en-têtes spécifiques à destination de la machine virtuelle,
160 + # par exemple pour que celle-ci comprenne qu'elle se trouve derrière un frontal web.
161 + location / {
162 + proxy_set_header Host $host;
163 + proxy_set_header X-Forwarded-For $remote_addr;
164 + proxy_pass http://monservice-prod.prod.infra.atilla.org/;
165 + }
166 +}
167 +{{/code}}
168 +
169 +=== Création du dossier de logs ===
170 +
171 +Comme vu dans la configuration précédente, on va stocker les logs Nginx dans ##/var/log/nginx/monservice.atilla.org##. Par défaut, ce dossier n'existe pas et il faut le créer (sinon, Nginx ne démarrera pas).
172 +
173 +{{code language="shell"}}
174 +mkdir /var/log/nginx/monservice.atilla.org
175 +{{/code}}
176 +
177 +=== Activation de la configuration Nginx ===
178 +
179 +Finalement, il faut s'assurer qu'Nginx prendra en compte notre fichier de configuration. Si vous regardez dans ##/etc/nginx##, vous verrez deux dossiers :
180 +
181 +* ##sites-available##: celui dans lequel la configuration a été créée
182 +* ##sites-enabled##: celui dans lequel la configuration doit être référencée pour être active
183 +
184 +Pour activer la configuration en question, rien de plus simple, on fait juste un lien symbolique dans ##sites-enabled## vers le fichier qui convient :
185 +
186 +{{code language="shell"}}
187 +ln -sf /etc/nginx/sites-available/monservice.atilla.org /etc/nginx/sites-enabled/atilla.org/
188 +{{/code}}
189 +
190 +Avant de terminer cette manip, on vérifie que tout est bon au niveau de la configuration, et que Nginx ne va pas planter au redémarrage :
191 +
192 +{{code language="shell"}}
193 +nginx -t
194 +{{/code}}
195 +
196 +Et finalement, on redémarre !
197 +
198 +{{code language="shell"}}
199 +systemctl restart nginx
200 +{{/code}}
201 +
202 +== Méthode plus ou moins automatique ==
203 +
123 123  On a un [[super projet sur GitLab>>https://gitlab.atilla.org/adminsys/nginx-config-generator]] qui permet d’effectuer les actions de la méthode manuelle de manière automatique. Ce projet est présent sur ##/root/nginx-config-generator## sur Bill, voici comment l’utiliser rapidement. En cas de besoin, référez vous au ##README.md## du projet.
124 124  
125 125  {{code language="shell"}}