ServBay

Français

English
简体中文
繁體中文
Español
العربية
Português
Русский
日本語
Deutsch
Tiếng Việt
Türkçe
Italiano

Français

English
简体中文
繁體中文
Español
العربية
Português
Русский
日本語
Deutsch
Tiếng Việt
Türkçe
Italiano

Appearance

Configuration d’environnement par projet avec le fichier .servbay.config ​

Vue d'ensemble ​

ServBay est un puissant outil de développement Web local qui permet aux développeurs de configurer des environnements d’exécution indépendants pour chaque projet. Cette fonctionnalité repose sur la prise en charge d’un fichier nommé .servbay.config placé dans le dossier de chaque projet.

Grâce au fichier .servbay.config, vous pouvez facilement spécifier pour un projet donné les versions requises des langages PHP, Node.js, Python, Go, Java, etc., et également configurer les gestionnaires de paquets Node.js (tels que NPM, Yarn) avec l’adresse du dépôt ou le dossier de cache, entre autres. Ce contrôle précis au niveau du projet améliore grandement l’efficacité et la commodité du développement, garantissant que chaque projet fonctionne dans l’environnement adapté et évite tout conflit de versions.

Principe de fonctionnement du fichier .servbay.config ​

Lorsque ServBay démarre ou recharge un site, il vérifie la présence d’un fichier .servbay.config dans le répertoire racine du site. Si le fichier existe, ServBay lit sa configuration et l’applique spécifiquement à l’environnement d’exécution de ce site. Ces réglages au niveau du projet ont la priorité sur les paramètres globaux correspondants de ServBay. Si le fichier .servbay.config est absent ou que certaines options ne sont pas définies, ServBay utilise alors les paramètres globaux par défaut.

Ce mécanisme permet une transition fluide entre les différents projets, car chacun transporte sa propre configuration d’environnement.

Comment créer et configurer le fichier .servbay.config ​

La création et la configuration du fichier .servbay.config est très simple.

Emplacement du fichier ​

Créez un fichier nommé .servbay.config à la racine de votre projet. Habituellement, ce dossier racine se situe dans le répertoire de stockage des sites ServBay, par exemple /Applications/ServBay/www/nom-de-votre-projet/.

Syntaxe de configuration ​

Le fichier .servbay.config adopte le format simple CLÉ=VALEUR pour chaque option de configuration, une par ligne. Vous pouvez ajouter des commentaires pour la lisibilité en commençant la ligne par le caractère #.

Exemple d’options de configuration ​

Voici un exemple de fichier .servbay.config montrant comment configurer différentes versions d’environnements et de gestionnaires de paquets :

bash
# Exemple de fichier .servbay.config

# Spécifie la version PHP utilisée. Assurez-vous que cette version est installée dans ServBay.
PHP_VERSION=8.5

# Spécifie la version Node.js utilisée. Assurez-vous que cette version est installée dans ServBay.
NODE_VERSION=20

# Configure l’adresse du dépôt miroir pour Yarn afin d’accélérer le téléchargement des dépendances.
YARN_CONFIG_REGISTRY=https://npmreg.proxy.ustclug.org/

# Configure l’adresse du dépôt miroir pour NPM afin d’accélérer le téléchargement des dépendances.
NPM_CONFIG_REGISTRY=https://npmreg.proxy.ustclug.org/

# Spécifie le dossier de cache local pour NPM. Note : ce chemin est relatif au dossier d’installation de ServBay.
NPM_CONFIG_CACHE=/Applications/ServBay/tmp/npm/cache

# Spécifie le dossier de cache local pour Yarn. Note : ce chemin est relatif au dossier d’installation de ServBay.
YARN_CONFIG_CACHE=/Applications/ServBay/tmp/yarn/cache

# Spécifie la version de Ruby utilisée. Assurez-vous que cette version est installée dans ServBay.
RUBY_VERSION=2.7

# Spécifie la version Java (OpenJDK) utilisée. Assurez-vous que cette version est installée dans ServBay.
JAVA_VERSION=21

# Spécifie la version Python utilisée. Assurez-vous que cette version est installée dans ServBay.
PYTHON_VERSION=3.11

# Spécifie la version .NET utilisée. Assurez-vous que cette version est installée dans ServBay.
DOTNET_VERSION=5.0

# Spécifie la version Go utilisée. Assurez-vous que cette version est installée dans ServBay.
GO_VERSION=1.12

# Configure le proxy de modules Go pour accélérer les téléchargements.
GOPROXY=https://goproxy.cn,direct

Remarque : Les numéros de version figurant dans l’exemple (PHP_VERSION=8.5, NODE_VERSION=20, etc.) sont uniquement à titre indicatif. Lors de la configuration réelle, veuillez renseigner la version adaptée à vos besoins en fonction des versions installées et supportées dans ServBay. Si la version spécifiée n’est pas installée, ServBay utilisera une version par défaut ou affichera une erreur.

Types d’options de configuration prises en charge ​

D’après l’exemple ci-dessus, le fichier .servbay.config prend en charge principalement les types d’options suivants :

  1. Spécification de version d’environnement :

    • PHP_VERSION : version de PHP.
    • NODE_VERSION : version de Node.js.
    • RUBY_VERSION : version de Ruby.
    • JAVA_VERSION : version de Java (OpenJDK).
    • PYTHON_VERSION : version de Python.
    • DOTNET_VERSION : version de .NET.
    • GO_VERSION : version de Go.
    • (Veuillez consulter la documentation ServBay ou l’interface de l’application pour découvrir tous les environnements pris en charge et les noms exacts des variables de configuration.)

  2. Configuration des gestionnaires de paquets (Node.js) :

    • YARN_CONFIG_REGISTRY : adresse du dépôt miroir Yarn.
    • NPM_CONFIG_REGISTRY : adresse du dépôt miroir NPM.
    • NPM_CONFIG_CACHE : chemin du cache local NPM.
    • YARN_CONFIG_CACHE : chemin du cache local Yarn.

  3. Configuration du proxy des modules Go :

    • GOPROXY : adresse du serveur proxy pour les modules Go.

Ces options vous permettent de définir un environnement isolé par projet, sans interférence entre eux.

Application et vérification en pratique ​

Après avoir configuré le fichier .servbay.config, vous devez vérifier que ServBay a bien chargé votre projet (c’est-à-dire que le projet apparaît dans la liste des “Sites” de l’application ServBay). ServBay lira le fichier de configuration à chaque chargement ou rechargement du site.

Pour vérifier que la configuration est bien prise en compte, vous pouvez procéder de la manière suivante :

  1. Consultez l’interface de l’application ServBay : L’application peut afficher sur la page de détails du projet ou sur une interface dédiée les versions d’environnement actuellement appliquées pour ce projet.

  2. Validation via la ligne de commande : Ouvrez le terminal de ServBay et placez-vous dans le répertoire racine de votre projet, puis lancez les commandes suivantes pour vérifier les versions :

    • Vérifier la version de PHP : php -v
    • Vérifier la version de Node.js : node -v
    • Vérifier la version de Yarn : yarn -v
    • Vérifier la version de NPM : npm -v
    • Vérifier la version de Python : python -V ou python3 -V
    • Vérifier la version de Go : go version
    • Vérifier la version de Java : java -version
    • Vérifier la version de .NET : dotnet --version
    • Vérifier la version de Ruby : ruby -v

    Vérifiez que les versions affichées correspondent à celles spécifiées dans votre fichier .servbay.config.

  3. Vérification via une page Web (pour PHP) : Créez un fichier PHP simple dans le répertoire racine de votre projet (par exemple info.php) avec le contenu <?php phpinfo(); ?>. Accédez à ce fichier depuis votre navigateur (par exemple http://votre-projet.servbay.demo/info.php) : dans la page phpinfo générée, recherchez la version de PHP pour vérifier qu’elle correspond à la version indiquée.

L’exemple ci-dessous illustre l’interface de ServBay affichant la configuration projet correctement appliquée :

Exemple d’exécution de .servbay.config

(Veuillez vous référer à l’interface réelle de l’application ServBay pour observer les résultats concrets de la configuration.)

Points à retenir ​

  • Le nom du fichier .servbay.config doit être exact, sans faute de frappe.
  • Le fichier doit être placé à la racine du projet.
  • Les versions indiquées doivent être déjà installées et supportées par ServBay.
  • Chaque option doit être écrite sur une ligne distincte, au format CLÉ=VALEUR.
  • Toute erreur de syntaxe peut rendre le fichier ou certaines options inopérants.
  • Les paramètres du fichier .servbay.config remplacent les réglages globaux de ServBay et s’appliquent uniquement au projet courant.

Foire Aux Questions (FAQ) ​

Q : Que faire si mon projet ne contient pas de fichier .servbay.config ?

R : Si le fichier n’existe pas, ServBay utilisera la configuration globale définie dans l’interface de l’application pour exécuter votre projet.

Q : Que se passe-t-il si j’indique dans .servbay.config une version qui n’est pas installée sur ServBay ?

R : ServBay affichera une erreur ; le comportement exact dépend de la version et des réglages de ServBay. Pour garantir l’utilisation de la version souhaitée, veuillez vous assurer d’installer au préalable cette version via l’application ServBay.

Q : Dois-je redémarrer ServBay après avoir modifié le fichier .servbay.config ?

R : Généralement, après une modification du fichier .servbay.config, il suffit de recharger ou d’arrêter puis redémarrer le site concerné depuis l’application ServBay, sans avoir besoin de quitter complètement l’application.

Q : Les paramètres du fichier .servbay.config affectent-ils mes autres projets ?

R : Non. Le fichier .servbay.config ne concerne que le site ServBay où il se trouve et n’a aucun impact sur les autres projets.

Conclusion ​

Grâce au fichier .servbay.config, ServBay offre aux développeurs une gestion d’environnement granulaire à l’échelle du projet. Que vous mainteniez un projet héritant d’une ancienne pile technologique ou que vous développiez avec les dernières versions, il suffit de configurer ce fichier pour isoler et basculer rapidement d’un environnement à l’autre. Cette flexibilité augmente considérablement l’efficacité et la fluidité du développement local. Profitez pleinement de cette fonctionnalité pour optimiser vos workflows de développement.