Configuración de entornos por proyecto usando el archivo .servbay.config

Visión general

ServBay es una potente herramienta de entorno local para desarrollo web que permite a los desarrolladores configurar entornos independientes para cada uno de sus proyectos. Esta funcionalidad se basa en el soporte para crear un archivo denominado .servbay.config dentro del directorio de cada proyecto.

A través del archivo .servbay.config, puedes especificar fácilmente la versión necesaria de PHP, Node.js, Python, Go, Java y otros lenguajes para un proyecto en particular, así como configurar las direcciones de los repositorios de los gestores de paquetes de Node.js (como NPM, Yarn) y sus directorios de caché. Este nivel de control granular por proyecto mejora significativamente la eficiencia y comodidad en el desarrollo, asegurando que cada proyecto se ejecute en el entorno adecuado y evitando conflictos de versiones.

¿Cómo funciona el archivo .servbay.config?

Cuando ServBay inicia o recarga un sitio web, verifica si existe un archivo .servbay.config en el directorio raíz del sitio. Si se encuentra este archivo, ServBay lee su configuración y la aplica únicamente al entorno de ejecución de dicho proyecto. Estas configuraciones a nivel de proyecto sobrescriben los valores correspondientes en la configuración global de ServBay. Si el archivo no existe o no incluye alguna configuración específica, ServBay utilizará los valores globales predeterminados.

Gracias a este mecanismo, cambiar entre diferentes proyectos se vuelve totalmente transparente, ya que cada uno conserva su propia configuración ambiental.

Cómo crear y configurar el archivo .servbay.config

Crear y configurar el archivo .servbay.config es muy sencillo.

Ubicación del archivo

Crea el archivo llamado .servbay.config en la raíz de tu proyecto. Normalmente, la raíz del proyecto se encuentra en la ruta de almacenamiento de sitios web de ServBay, por ejemplo: /Applications/ServBay/www/tu-nombre-de-proyecto/.

Sintaxis de configuración

El archivo .servbay.config utiliza una sintaxis simple basada en pares CLAVE=VALOR, una configuración por línea. Puedes agregar comentarios usando el símbolo # para mejorar la legibilidad.

Ejemplo de opciones de configuración

A continuación, se muestra un ejemplo de archivo .servbay.config en el que se configuran varias versiones ambientales y ajustes para gestores de paquetes:

# Ejemplo de archivo .servbay.config

# Especifica la versión de PHP. Asegúrate de que esta versión esté instalada en ServBay.
PHP_VERSION=8.5

# Especifica la versión de Node.js. Asegúrate de que esta versión esté instalada en ServBay.
NODE_VERSION=20

# Configura la dirección del registro de Yarn para acelerar la descarga de dependencias.
YARN_CONFIG_REGISTRY=https://npmreg.proxy.ustclug.org/

# Configura la dirección del registro de NPM para acelerar la descarga de dependencias.
NPM_CONFIG_REGISTRY=https://npmreg.proxy.ustclug.org/

# Especifica el directorio de caché local para NPM. Nota: la ruta es relativa al directorio de instalación de ServBay.
NPM_CONFIG_CACHE=/Applications/ServBay/tmp/npm/cache

# Especifica el directorio de caché local para Yarn. Nota: la ruta es relativa al directorio de instalación de ServBay.
YARN_CONFIG_CACHE=/Applications/ServBay/tmp/yarn/cache

# Especifica la versión de Ruby. Asegúrate de que esta versión esté instalada en ServBay.
RUBY_VERSION=2.7

# Especifica la versión de Java (OpenJDK). Asegúrate de que esta versión esté instalada en ServBay.
JAVA_VERSION=21

# Especifica la versión de Python. Asegúrate de que esta versión esté instalada en ServBay.
PYTHON_VERSION=3.11

# Especifica la versión de .NET. Asegúrate de que esta versión esté instalada en ServBay.
DOTNET_VERSION=5.0

# Especifica la versión de Go. Asegúrate de que esta versión esté instalada en ServBay.
GO_VERSION=1.12

# Configura el servidor proxy para módulos de Go para acelerar la descarga de módulos.
GOPROXY=https://goproxy.cn,direct

Nota: Los números de versión en el ejemplo (PHP_VERSION=8.5, NODE_VERSION=20, etc.) son meramente ilustrativos. Debes elegir los valores correctos según los requerimientos de tu proyecto y las versiones instaladas y soportadas por ServBay. Si la versión indicada no está instalada, ServBay podría usar la versión predeterminada o mostrar un error.

Tipos de opciones de configuración soportadas

Basado en el ejemplo anterior, el archivo .servbay.config admite principalmente los siguientes tipos de configuraciones:

1. Definir versiones del entorno:

   • PHP_VERSION: Especifica la versión de PHP.
   • NODE_VERSION: Especifica la versión de Node.js.
   • RUBY_VERSION: Especifica la versión de Ruby.
   • JAVA_VERSION: Especifica la versión de Java (OpenJDK).
   • PYTHON_VERSION: Especifica la versión de Python.
   • DOTNET_VERSION: Especifica la versión de .NET.
   • GO_VERSION: Especifica la versión de Go.
   • (Consulta la documentación de ServBay o la interfaz de usuario para ver todos los entornos soportados y los nombres de sus variables de configuración.)

2. Configuración de gestores de paquetes (Node.js):

   • YARN_CONFIG_REGISTRY: Dirección del registro de Yarn.
   • NPM_CONFIG_REGISTRY: Dirección del registro de NPM.
   • NPM_CONFIG_CACHE: Ruta del directorio local de caché de NPM.
   • YARN_CONFIG_CACHE: Ruta del directorio local de caché de Yarn.

3. Configuración de proxy de módulos de Go:

   • GOPROXY: Dirección del servidor proxy para módulos de Go.

Estas configuraciones te permiten tener un entorno aislado para cada proyecto, sin afectar a los demás.

Aplicación práctica y verificación

Después de configurar el archivo .servbay.config, asegúrate de que tu proyecto esté cargado en ServBay (es decir, que aparezca en la lista de “Sitios web” de la aplicación). ServBay leerá el archivo de configuración cada vez que cargues o recargues el sitio.

Para comprobar que la configuración está activa, puedes:

1. Verificar en la interfaz de ServBay: Es posible que ServBay muestre en el panel de detalles del sitio o en áreas similares la versión del entorno actualmente aplicada al proyecto.

2. Verificar por línea de comandos: Abre la terminal integrada de ServBay y asegúrate de situarte en el directorio raíz de tu proyecto. Luego ejecuta los comandos correspondientes para consultar las versiones, por ejemplo:

   • Verificar versión de PHP: php -v
   • Verificar versión de Node.js: node -v
   • Verificar versión de Yarn: yarn -v
   • Verificar versión de NPM: npm -v
   • Verificar versión de Python: python -V o python3 -V
   • Verificar versión de Go: go version
   • Verificar versión de Java: java -version
   • Verificar versión de .NET: dotnet --version
   • Verificar versión de Ruby: ruby -v Comprueba que el resultado coincida con la versión especificada en el archivo .servbay.config.

3. Verificar mediante página web (para PHP): Crea un archivo PHP sencillo (por ejemplo, info.php) en la raíz de tu proyecto con el siguiente contenido: <?php phpinfo(); ?>. Accede a la página a través del navegador (como http://your-project.servbay.demo/info.php) y revisa en la información de phpinfo que la versión corresponda a la configurada.

La siguiente imagen podría mostrar cómo se refleja la configuración de proyecto activa en la interfaz de ServBay:

(Consulta la salida real de la aplicación ServBay para comprobar el funcionamiento exacto de la configuración.)

Consideraciones

• El nombre del archivo debe ser exactamente .servbay.config, sin errores tipográficos.
• Debe ubicarse en la raíz del proyecto.
• Las versiones especificadas deben estar ya instaladas y soportadas por ServBay.
• Las opciones deben estar separadas por líneas, una pareja CLAVE=VALOR por línea.
• Errores de sintaxis pueden hacer que el archivo completo sea ignorado o que ciertas opciones no funcionen.
• Las configuraciones del archivo .servbay.config sobrescribirán los valores globales de ServBay y solo afectarán al proyecto correspondiente.

Preguntas frecuentes (FAQ)

P: ¿Qué ocurre si no existe el archivo .servbay.config en la raíz de mi proyecto?

R: Si el archivo no está presente, ServBay utilizará la configuración de entorno global definida en la aplicación para ejecutar tu proyecto.

P: ¿Qué sucede si especifico una versión que no está instalada en ServBay?

R: ServBay mostrará un error, aunque la respuesta exacta dependerá de la versión y configuración de la aplicación. Para garantizar que se use la versión deseada, asegúrate de instalarla primero mediante la aplicación de ServBay.

P: ¿Necesito reiniciar ServBay tras modificar el archivo .servbay.config?

R: Normalmente, basta con recargar o detener y reiniciar el sitio web correspondiente desde la aplicación ServBay; no es necesario cerrar y volver a abrir toda la aplicación.

P: ¿La configuración de un archivo .servbay.config afecta a mis otros proyectos?

R: No. Este archivo solo aplica a la carpeta de sitio correspondiente dentro de ServBay; no modifica otros proyectos.

Resumen

El archivo .servbay.config ofrece a los desarrolladores potentes capacidades de gestión de entornos a nivel de proyecto en ServBay. Ya sea para mantener proyectos heredados que requieren versiones antiguas de entornos, o para trabajar en desarrollos nuevos con tecnologías recientes, basta con adaptar este archivo para cambiar y aislar entornos rápidamente, incrementando así la flexibilidad y eficiencia del desarrollo local. Aprovecha esta funcionalidad para optimizar tu flujo de trabajo y conseguir una experiencia de desarrollo mucho más fluida.