Serveur Apache HTTP Version 2.3
Ce document propose une méthode performante pour servir un nombre quelconque d'hôtes virtuels avec le serveur web httpd Apache.
mod_rewrite
mod_rewrite
Les techniques décrites ici vous concernent si votre
httpd.conf
contient de nombreuses sections
<VirtualHost>
très semblables,
dans le style :
NameVirtualHost 111.22.33.44
<VirtualHost 111.22.33.44>
ServerName www.customer-1.com
DocumentRoot /www/hosts/www.customer-1.com/docs
ScriptAlias /cgi-bin/ /www/hosts/www.customer-1.com/cgi-bin
</VirtualHost>
<VirtualHost 111.22.33.44>
ServerName www.customer-2.com
DocumentRoot /www/hosts/www.customer-2.com/docs
ScriptAlias /cgi-bin/ /www/hosts/www.customer-2.com/cgi-bin
</VirtualHost>
# bla bla bla
<VirtualHost 111.22.33.44>
ServerName www.customer-N.com
DocumentRoot /www/hosts/www.customer-N.com/docs
ScriptAlias /cgi-bin/ /www/hosts/www.customer-N.com/cgi-bin
</VirtualHost>
L'idée de base consiste à remplacer toutes les configurations
<VirtualHost>
par un mécanisme qui les génère
dynamiquement. Ceci présente certains avantages :
Le principal désavantage réside dans le fait que vous ne pouvez pas définir un fichier journal différent pour chaque serveur virtuel. De toute façon, ce serait une mauvaise idée si vous avez de nombreux serveurs virtuels, car cela nécessiterait un nombre important de descripteurs de fichiers. Il est préférable de rediriger les journaux via un pipe ou une pile fifo vers un programme, et faire en sorte que ce dernier distribue les journaux les concernant aux différents clients (Ce qui peut aussi servir à accumuler des données à des fins de statistiques, etc...).
Un serveur virtuel peut être défini par deux informations : son
adresse IP, et le contenu de l'en-tête Host:
de la
requête HTTP. La technique d'hébergement virtuel dynamique de masse
utilisée ici consiste à insérer automatiquement ces informations
dans le chemin du fichier à utiliser pour répondre à la requête. On
peut y parvenir assez facilement en utilisant
mod_vhost_alias
avec Apache 2.0, mais on peut aussi
utiliser mod_rewrite
. Par défaut, ces deux modules
sont désactivés ; vous devez activer l'un d'eux lors de la
compilation et de la configuration d'Apache si vous voulez utiliser
cette technique.
Certains paramètres doivent être adaptés pour que le serveur
dynamique se présente comme un serveur dynamique normal. Le plus
important est le nom du serveur, qu'Apache utilise pour générer des
URLs d'auto-référencement, etc... Il est défini via la directive
ServerName
, et les CGIs peuvent s'y référer via la
variable d'environnement SERVER_NAME
. Sa véritable
valeur utilisée à l'exécution est contrôlée par la définition de la
directive
UseCanonicalName
. Avec
UseCanonicalName Off
, le nom du serveur correspond au
contenu de l'en-tête Host:
de la requête. Avec
UseCanonicalName DNS
, il est extrait d'une recherche
DNS inverse sur l'adresse IP du serveur virtuel. La première
configuration est utilisée pour l'hébergement virtuel dynamique par
nom, et la deuxième pour l'hébergement virtuel dynamique par IP. Si
Apache ne peut pas déterminer le nom du serveur, soit parce qu'il
n'y a pas d'en-tête Host:
, soit parce que la recherche
DNS a échoué, il prend en compte la valeur définie par la directive
ServerName
.
L'autre paramètre à adapter est la racine des documents (définie
via la directive DocumentRoot
et disponible pour les
CGIs via la variable d'environnement DOCUMENT_ROOT
).
Dans une configuration classique, il est utilisé par le module core
pour faire correspondre les URIs aux noms de fichiers, mais lorsque
la configuration du serveur comporte des serveurs virtuels, ce
traitement doit être pris en charge par un autre module (soit
mod_vhost_alias
, soit mod_rewrite
), qui
utilise un méthode de correspondance différente. Aucun de ces
modules ne se chargeant de définir la variable d'environnement
DOCUMENT_ROOT
, si des CGIs ou des documents SSI
doivent en faire usage, ils obtiendront une valeur erronée.
Cet extrait de fichier httpd.conf
implémente
l'hébergement virtuel décrit dans la section À qui ce document est-il destiné ? ci-dessus,
mais selon une méthode générique utilisant
mod_vhost_alias
.
# extrait le nom du serveur de l'en-tête Host:
UseCanonicalName Off
# ce format de journal peut être éclaté en journaux par serveur virtuel
# à l'aide du premier champ
LogFormat "%V %h %l %u %t \"%r\" %s %b" vcommon
CustomLog logs/access_log vcommon
# inclut le nom du serveur dans les noms de fichiers ressources
# nécessaires aux traitements des requêtes
VirtualDocumentRoot /www/hosts/%0/docs
VirtualScriptAlias /www/hosts/%0/cgi-bin
Pour changer cette configuration en solution de serveur virtuel
par IP, il suffit de remplacer UseCanonicalName
Off
par UseCanonicalName DNS
. Le nom du serveur
inséré dans le nom de fichier sera alors déduit de l'adresse IP du
serveur virtuel.
Il s'agit d'une adaptation du système ci-dessus, ajusté pour un
serveur de pages d'accueil de FAI. Avec une configuration un peu
plus compliquée, on peut extraire des sous-chaînes de caractères du
nom du serveur pour les utiliser dans le nom de fichier afin, par
exemple, de définir /home/user/
comme emplacement des
documents pour www.user.isp.com
. Un seul répertoire
cgi-bin
suffit pour l'ensemble des
serveurs virtuels.
# les directives préliminaires sont identiques à celles de l'exemple
# ci-dessus ; il vient ensuite :
# insertion d'une partie du nom du serveur dans les noms de fichiers
VirtualDocumentRoot /www/hosts/%2/docs
# répertoire cgi-bin unique
ScriptAlias /cgi-bin/ /www/std-cgi/
Vous trouverez des exemples plus élaborés d'utilisation de la
directive VirtualDocumentRoot
dans la documentation du
module mod_vhost_alias
.
Moyennant une configuration un peu plus compliquée, vous pouvez
contrôler la portée des différentes configurations d'hébergement
virtuel à l'aide des directives <VirtualHost>
normales d'Apache. Par exemple, on peut associer une adresse IP pour
les pages d'accueil des clients en général, et une autre pour les
clients commerciaux avec la configuration suivante. Cette
configuration peut bien entendu être combinée avec les sections
<VirtualHost>
conventionnelles.
UseCanonicalName Off
LogFormat "%V %h %l %u %t \"%r\" %s %b" vcommon
<Directory /www/commercial>
Options FollowSymLinks
AllowOverride All
</Directory>
<Directory /www/homepages>
Options FollowSymLinks
AllowOverride None
</Directory>
<VirtualHost 111.22.33.44>
ServerName www.commercial.isp.com
CustomLog logs/access_log.commercial vcommon
VirtualDocumentRoot /www/commercial/%0/docs
VirtualScriptAlias /www/commercial/%0/cgi-bin
</VirtualHost>
<VirtualHost 111.22.33.45>
ServerName www.homepages.isp.com
CustomLog logs/access_log.homepages vcommon
VirtualDocumentRoot /www/homepages/%0/docs
ScriptAlias /cgi-bin/ /www/std-cgi/
</VirtualHost>
Si le premier bloc VirtualHost ne comporte pas de
directive ServerName
, c'est
le nom issu d'une recherche DNS inverse à partir de l'adresse IP
du serveur virtuel qui sera utilisé. Si ce nom ne correspond pas
à celui que vous voulez utiliser, vous pouvez ajouter une entrée
de remplacement (ServerName
none.example.com
) pour éviter ce comportement.
Les changements de configuration suggérés pour transformer le premier exemple en hébergement virtuel par IP conduisent à une configuration peu efficace. Chaque requête nécessite une nouvelle recherche DNS. Pour éviter cette surcharge de travail, le système de fichiers peut être organisé pour correspondre aux adresses IP, plutôt qu'aux noms de serveurs, supprimant par la-même la nécessité d'une recherche DNS. La journalisation doit aussi être adaptée pour fonctionner sur un tel système.
# obtention du nom du serveur par recherche DNS inverse
# sur l'adresse IP
UseCanonicalName DNS
# insertion de l'adresse IP dans les journaux afin de pouvoir les
# éclater
LogFormat "%A %h %l %u %t \"%r\" %s %b" vcommon
CustomLog logs/access_log vcommon
# insertion de l'adresse IP dans les noms de fichiers
VirtualDocumentRootIP /www/hosts/%0/docs
VirtualScriptAliasIP /www/hosts/%0/cgi-bin
mod_rewrite
Cet extrait de httpd.conf
fournit le même service
que le premier exemple. La première moitié est
très similaire à sa contre-partie du premier
exemple, mis à part quelques changements à des fins de
compatibilité ascendante et nécessaires au bon fonctionnement de la
partie concernant mod_rewrite
; la seconde moitié
configure mod_rewrite
pour l'accomplissement du travail
proprement dit.
Cet exemple comporte quelques astuces assez spéciales : par
défaut, mod_rewrite
effectue son traitement avant les
autres modules de transformation d'URI (mod_alias
etc...) - ainsi, si vous voulez utiliser ces modules, il faut en
tenir compte dans la configuration de mod_rewrite
. De
même, l'implémentation d'un serveur virtuel dynamique équivalent à
ScriptAlias
demande une certaine manipulation.
# obtention du nom du serveur par la valeur de l'en-tête Host:
UseCanonicalName Off
# journaux pouvant être éclatés en journaux par serveurs virtuels
LogFormat "%{Host}i %h %l %u %t \"%r\" %s %b" vcommon
CustomLog logs/access_log vcommon
<Directory /www/hosts>
# ExecCGI est ici nécessaire car nous ne pouvons pas forcer
# l'exécution des CGI de la manière dont ScriptAlias le fait
Options FollowSymLinks ExecCGI
</Directory>
# et maintenant, nous entrons dans le vif du sujet
RewriteEngine On
# un nom de serveur déduit de l'en-tête Host: dans pratiquement tous les
# cas
RewriteMap lowercase int:tolower
## traitement des documents normaux en premier:
# permet le fonctionnement de "Alias /icons/" - à répéter pour les
# autres aliases
RewriteCond %{REQUEST_URI} !^/icons/
# permet le fonctionnement des CGIs
RewriteCond %{REQUEST_URI} !^/cgi-bin/
# la petite manipulation magique
RewriteRule ^/(.*)$ /www/hosts/${lowercase:%{SERVER_NAME}}/docs/$1
## on s'occupe maintenant des CGIs - on doit imposer l'utilisation d'un
# gestionnaire
RewriteCond %{REQUEST_URI} ^/cgi-bin/
RewriteRule ^/(.*)$ /www/hosts/${lowercase:%{SERVER_NAME}}/cgi-bin/$1 [H=cgi-script]
# c'est tout !
mod_rewrite
Il s'agit d'une variante qui permet d'obtenir le même résultat que le deuxième exemple.
RewriteEngine on
RewriteMap lowercase int:tolower
# permet l'exécution des CGIs
RewriteCond %{REQUEST_URI} !^/cgi-bin/
# vérifie la validité du nom du serveur pour le bon fonctionnement de la
# règle RewriteRule
RewriteCond ${lowercase:%{SERVER_NAME}} ^www\.[a-z-]+\.isp\.com$
# ajoute le nom du serveur virtuel comme préfixe à l'URI
# le drapeau [C] signifie que la réécriture suivante doit être effectuée
# sur le résultat de la règle courante
RewriteRule ^(.+) ${lowercase:%{SERVER_NAME}}$1 [C]
# et maintenant, on crée le véritable nom de fichier
RewriteRule ^www\.([a-z-]+)\.isp\.com/(.*) /home/$1/$2
# définition du répertoire des CGIs global
ScriptAlias /cgi-bin/ /www/std-cgi/
Cette méthode utilise des fonctionnalités de
mod_rewrite
plus avancées pour venir à bout de la
traduction d'un serveur virtuel en une racine de documents, à partir
d'un fichier de configuration séparé. Elle procure d'avantage de
souplesse, mais nécessite une configuration
un peu plus compliquée.
Le fichier vhost.map
doit se présenter sous cette
forme :
www.customer-1.com /www/customers/1
www.customer-2.com /www/customers/2
# ...
www.customer-N.com /www/customers/N
Le fichier httpd.conf
doit contenir les lignes
suivantes :
RewriteEngine on
RewriteMap lowercase int:tolower
# définition du fichier de correspondances
RewriteMap vhost txt:/www/conf/vhost.map
# traite les alias comme précédemment
RewriteCond %{REQUEST_URI} !^/icons/
RewriteCond %{REQUEST_URI} !^/cgi-bin/
RewriteCond ${lowercase:%{SERVER_NAME}} ^(.+)$
# une nouvelle mise en correspondance par fichier
RewriteCond ${vhost:%1} ^(/.*)$
RewriteRule ^/(.*)$ %1/docs/$1
RewriteCond %{REQUEST_URI} ^/cgi-bin/
RewriteCond ${lowercase:%{SERVER_NAME}} ^(.+)$
RewriteCond ${vhost:%1} ^(/.*)$
RewriteRule ^/(.*)$ %1/cgi-bin/$1 [H=cgi-script]