Configuração de Ambiente por Projeto com o Arquivo .servbay.config

Visão Geral

O ServBay é uma poderosa ferramenta de ambiente de desenvolvimento web local, permitindo que desenvolvedores configurem ambientes de execução independentes para diferentes projetos. O núcleo desse recurso é a possibilidade de criar um arquivo chamado .servbay.config em cada diretório de projeto.

Por meio do arquivo .servbay.config, você pode facilmente especificar para cada projeto as versões necessárias de linguagens como PHP, Node.js, Python, Go, Java, entre outras, além de configurar opções dos gerenciadores de pacotes do Node.js (como NPM e Yarn), definindo endereços de repositório e diretórios de cache. Esse controle refinado no nível do projeto aumenta consideravelmente a eficiência e a comodidade do desenvolvimento, garantindo que cada projeto rode de maneira estável em seu ambiente ideal e evitando problemas de conflito de versões.

Como Funciona o Arquivo .servbay.config

Quando o ServBay é iniciado ou um site é recarregado, ele verifica se existe um arquivo .servbay.config na raiz do diretório do site. Se o arquivo existir, o ServBay lê as configurações e as aplica ao ambiente de execução desse site específico. Essas definições no nível do projeto sobrescrevem as configurações globais equivalentes do ServBay. Caso não exista o arquivo, ou algum item não esteja definido, o ServBay utilizará as configurações globais como padrão.

Esse mecanismo proporciona uma alternância perfeita entre projetos, pois cada um carrega sua própria configuração de ambiente.

Como Criar e Configurar o .servbay.config

A criação e configuração do arquivo .servbay.config é bastante simples.

Localização do Arquivo

Crie o arquivo .servbay.config na raiz do seu projeto. Normalmente, esse diretório raiz está localizado no caminho de sites do ServBay, como por exemplo: /Applications/ServBay/www/seu-nome-de-projeto/.

Sintaxe da Configuração

O arquivo .servbay.config utiliza o formato simples CHAVE=VALOR para definir configurações, uma por linha. Utilize o símbolo # para adicionar comentários e assim tornar o arquivo mais legível.

Exemplo de Opções de Configuração

Veja abaixo um exemplo de como configurar diferentes versões de ambientes e definições de gerenciadores de pacotes com o .servbay.config:

# Exemplo de arquivo .servbay.config

# Especifica a versão do PHP. Certifique-se que esta versão está instalada no ServBay.
PHP_VERSION=8.5

# Especifica a versão do Node.js. Certifique-se que esta versão está instalada no ServBay.
NODE_VERSION=20

# Configura o repositório espelho do Yarn para agilizar downloads de dependências.
YARN_CONFIG_REGISTRY=https://npmreg.proxy.ustclug.org/

# Configura o repositório espelho do NPM para agilizar downloads de dependências.
NPM_CONFIG_REGISTRY=https://npmreg.proxy.ustclug.org/

# Especifica o diretório de cache local do NPM. Observação: este caminho é relativo ao diretório de instalação do ServBay.
NPM_CONFIG_CACHE=/Applications/ServBay/tmp/npm/cache

# Especifica o diretório de cache local do Yarn. Observação: este caminho é relativo ao diretório de instalação do ServBay.
YARN_CONFIG_CACHE=/Applications/ServBay/tmp/yarn/cache

# Especifica a versão do Ruby. Certifique-se que esta versão está instalada no ServBay.
RUBY_VERSION=2.7

# Especifica a versão do Java (OpenJDK). Certifique-se que esta versão está instalada no ServBay.
JAVA_VERSION=21

# Especifica a versão do Python. Certifique-se que esta versão está instalada no ServBay.
PYTHON_VERSION=3.11

# Especifica a versão do .NET. Certifique-se que esta versão está instalada no ServBay.
DOTNET_VERSION=5.0

# Especifica a versão do Go. Certifique-se que esta versão está instalada no ServBay.
GO_VERSION=1.12

# Configura o proxy de módulos do Go para agilizar downloads.
GOPROXY=https://goproxy.cn,direct

Atenção: Os números das versões neste exemplo (PHP_VERSION=8.5, NODE_VERSION=20 e assim por diante) são apenas ilustrativos. Ao usar no seu projeto real, preencha com as versões adequadas conforme suas necessidades e as opções instaladas/suportadas pelo seu ServBay. Caso a versão especificada não esteja instalada, o ServBay poderá usar a versão padrão ou exibir um erro.

Tipos de Itens de Configuração Suportados

Com base no exemplo acima, o arquivo .servbay.config oferece suporte principalmente aos seguintes tipos de configuração:

1. Especificação de versão de ambiente:

   • PHP_VERSION: Versão do PHP.
   • NODE_VERSION: Versão do Node.js.
   • RUBY_VERSION: Versão do Ruby.
   • JAVA_VERSION: Versão do Java (OpenJDK).
   • PYTHON_VERSION: Versão do Python.
   • DOTNET_VERSION: Versão do .NET.
   • GO_VERSION: Versão do Go.
   • (Consulte a documentação do ServBay ou a interface do aplicativo para ver todos os tipos de ambiente e as variáveis disponíveis.)

2. Configuração de gerenciadores de pacotes (Node.js):

   • YARN_CONFIG_REGISTRY: Repositório espelho do Yarn.
   • NPM_CONFIG_REGISTRY: Repositório espelho do NPM.
   • NPM_CONFIG_CACHE: Diretório de cache local do NPM.
   • YARN_CONFIG_CACHE: Diretório de cache local do Yarn.

3. Configuração de proxy de módulos Go:

   • GOPROXY: Endereço do proxy de módulos do Go.

Essas opções permitem definir um ambiente isolado para cada projeto, sem interferência mútua entre eles.

Aplicação Prática e Validação

Após configurar o .servbay.config, você deve garantir que o seu projeto está carregado no ServBay (ou seja, que ele aparece na lista de “Sites” do aplicativo). O ServBay lerá esse arquivo ao carregar ou recarregar o site.

Para validar se as configurações estão em vigor, você pode seguir os métodos abaixo:

1. Verificando na interface do ServBay: O aplicativo pode exibir em detalhes do site ou em telas relacionadas as versões de ambiente atualmente aplicadas ao projeto.

2. Verificação via linha de comando: Abra o terminal integrado do ServBay e certifique-se de estar no diretório raiz do seu projeto. Em seguida, execute comandos para checar as versões, como:

   • Verificar versão do PHP: php -v
   • Verificar versão do Node.js: node -v
   • Verificar versão do Yarn: yarn -v
   • Verificar versão do NPM: npm -v
   • Verificar versão do Python: python -V ou python3 -V
   • Verificar versão do Go: go version
   • Verificar versão do Java: java -version
   • Verificar versão do .NET: dotnet --version
   • Verificar versão do Ruby: ruby -v Confira se o resultado corresponde às versões definidas em seu arquivo .servbay.config.

3. Verificação via página web (para PHP): Crie um arquivo PHP simples (como info.php) na raiz do projeto com o conteúdo <?php phpinfo(); ?>. Acesse pelo navegador (exemplo: http://seu-projeto.servbay.demo/info.php) e procure a versão do PHP exibida na página para confirmar que está conforme a configuração.

A imagem abaixo pode ilustrar um exemplo do ServBay refletindo as configurações por projeto na interface:

(Consulte sempre o resultado real exibido pelo aplicativo ServBay para confirmar o funcionamento das configurações.)

Observações Importantes

• O nome do arquivo .servbay.config deve estar correto, sem erros de digitação.
• O arquivo precisa estar no diretório raiz do projeto.
• As versões indicadas devem estar previamente instaladas e serem suportadas pelo ServBay.
• Use uma linha para cada CHAVE=VALOR, separadas por quebras de linha.
• Erros de sintaxe podem fazer com que o arquivo seja ignorado ou parte das configurações não funcione.
• As definições do .servbay.config sobrescrevem configurações globais do ServBay e afetam apenas o projeto atual.

Perguntas Frequentes (FAQ)

P: O que acontece se meu projeto não tiver o arquivo .servbay.config?

R: Se o arquivo não existir, o ServBay executará seu projeto usando as configurações globais definidas na interface do aplicativo.

P: O que ocorre se eu definir uma versão não instalada no ServBay no arquivo .servbay.config?

R: O ServBay exibirá um erro; o comportamento específico pode variar conforme a versão do aplicativo e as configurações. Para garantir a aplicação da versão desejada, instale-a antes via o próprio ServBay.

P: Preciso reiniciar o ServBay após alterar o arquivo .servbay.config?

R: Normalmente, basta recarregar ou parar/iniciar novamente o site afetado pela alteração dentro do aplicativo ServBay; não é necessário fechar completamente o aplicativo.

P: As configurações no arquivo .servbay.config impactam outros projetos?

R: Não. O .servbay.config é específico do projeto, valendo apenas para o diretório do site onde está inserido.

Resumo

O arquivo .servbay.config oferece ao desenvolvedor um poderoso recurso de gerenciamento de ambientes por projeto no ServBay. Seja para manter projetos legados que dependem de versões antigas ou para utilizar tecnologias de ponta em novos projetos, basta alterar este arquivo para alternar e isolar ambientes rapidamente, aumentando assim flexibilidade e produtividade no desenvolvimento local. Aproveite ao máximo este recurso para tornar seu fluxo de trabalho ainda mais eficiente.