Налаштування проєктного середовища за допомогою файлу .servbay.config

Огляд

ServBay — це потужний інструмент для локального веб-розробки, який дозволяє розробникам налаштовувати окреме середовище виконання для різних проєктів. Ключем до цього є підтримка конфігураційного файлу з назвою .servbay.config у кожній кореневій теці проєкту.

Завдяки файлу .servbay.config ви можете легко визначати версії мов програмування (PHP, Node.js, Python, Go, Java тощо), необхідні для конкретного проєкту, а також налаштовувати менеджери пакетів для Node.js (наприклад, NPM або Yarn): встановлювати адреси репозиторіїв та шляхи до кешу. Такий проектний рівень контролю значно підвищує ефективність і зручність розробки, забезпечуючи стабільну роботу кожного проєкту у потрібному ізольованому середовищі й запобігаючи конфліктам версій.

Як працює файл .servbay.config

Коли ServBay запускається або перевантажує сайт, він перевіряє наявність файлу .servbay.config у кореневій теці сайту. Якщо файл існує — ServBay читає налаштування звідти та застосовує їх до поточного середовища виконання. Проєктні конфігурації мають вищий пріоритет за глобальні налаштування ServBay. Якщо ж файл .servbay.config відсутній чи певний параметр у ньому не задано — буде використано глобальні (дефолтні) налаштування.

Цей механізм забезпечує безшовне перемикання між різними проєктами — кожен містить власну конфігурацію оточення.

Як створити і налаштувати .servbay.config

Створити і налаштувати файл .servbay.config дуже просто.

Розташування файлу

Створіть файл з назвою .servbay.config в кореневій теці вашого проєкту. Зазвичай корінь проєкту знаходиться у каталозі сайтів ServBay, наприклад: /Applications/ServBay/www/назва_вашого_проєкту/.

Синтаксис налаштувань

Файл .servbay.config використовує простий формат КЛЮЧ=ЗНАЧЕННЯ: одна налаштування на рядок. Для коментарів використовуйте символ # — це підвищує читабельність конфігурації.

Приклад налаштування

Нижче — приклад файлу .servbay.config, який демонструє, як задавати версії середовищ та параметри менеджерів пакетів:

# Приклад файлу .servbay.config

# Вказати версію PHP для виконання. Переконайтеся, що ця версія встановлена у ServBay.
PHP_VERSION=8.5

# Вказати версію Node.js для виконання. Переконайтеся, що ця версія встановлена у ServBay.
NODE_VERSION=20

# Вказати адресу дзеркального репозиторію Yarn для прискорення скачування залежностей.
YARN_CONFIG_REGISTRY=https://npmreg.proxy.ustclug.org/

# Вказати адресу дзеркального репозиторію NPM для прискорення скачування залежностей.
NPM_CONFIG_REGISTRY=https://npmreg.proxy.ustclug.org/

# Вказати локальний каталог кешу NPM. Примітка: шлях відносно директорії встановлення ServBay.
NPM_CONFIG_CACHE=/Applications/ServBay/tmp/npm/cache

# Вказати локальний каталог кешу Yarn. Примітка: шлях відносно директорії встановлення ServBay.
YARN_CONFIG_CACHE=/Applications/ServBay/tmp/yarn/cache

# Вказати версію Ruby для виконання. Переконайтеся, що ця версія встановлена у ServBay.
RUBY_VERSION=2.7

# Вказати версію Java (OpenJDK) для виконання. Переконайтеся, що ця версія встановлена у ServBay.
JAVA_VERSION=21

# Вказати версію Python для виконання. Переконайтеся, що ця версія встановлена у ServBay.
PYTHON_VERSION=3.11

# Вказати версію .NET для виконання. Переконайтеся, що ця версія встановлена у ServBay.
DOTNET_VERSION=5.0

# Вказати версію Go для виконання. Переконайтеся, що ця версія встановлена у ServBay.
GO_VERSION=1.12

# Налаштувати сервер-проксі для Go-модулів, щоб пришвидшити завантаження модулів.
GOPROXY=https://goproxy.cn,direct

Зверніть увагу: версії у прикладі (PHP_VERSION=8.5, NODE_VERSION=20 і т.д.) наведені лише для ілюстрації. У реальних випадках підбирайте значення згідно з вашими вимогами та наявністю потрібних версій у себе в ServBay. Якщо зазначена версія відсутня, ServBay може використати версію за замовчуванням або вивести попередження.

Підтримувані типи конфігурацій

Виходячи з наведеного прикладу, .servbay.config підтримує такі типи налаштувань:

1. Визначення версій середовищ:

   • PHP_VERSION: версія PHP
   • NODE_VERSION: версія Node.js
   • RUBY_VERSION: версія Ruby
   • JAVA_VERSION: версія Java (OpenJDK)
   • PYTHON_VERSION: версія Python
   • DOTNET_VERSION: версія .NET
   • GO_VERSION: версія Go
   • (Див. документацію ServBay або інтерфейс додатку для повного списку підтримуваних середовищ і відповідних змінних.)

2. Налаштування менеджерів пакетів (Node.js):

   • YARN_CONFIG_REGISTRY: дзеркало репозиторію Yarn
   • NPM_CONFIG_REGISTRY: дзеркало репозиторію NPM
   • NPM_CONFIG_CACHE: шлях до кешу NPM
   • YARN_CONFIG_CACHE: шлях до кешу Yarn

3. Налаштування Go-модулів:

   • GOPROXY: адреса проксі сервера для Go-модулів

Ці конфігурації дозволяють кожному проєкту мати власне ізольоване середовище, не впливаючи на інші проєкти.

Практичне використання та перевірка

Після налаштування файлу .servbay.config переконайтеся, що ваш проєкт доданий у список "Сайтів" додатка ServBay. ServBay прочитає конфігурацію при завантаженні або перезапуску сайту.

Перевірити, чи застосовано налаштування можна так:

1. Через інтерфейс ServBay: ServBay може відображати активні версії середовищ у деталях сайту чи відповідних вкладках.

2. Через командний рядок: Відкрийте вбудований термінал ServBay, перейдіть у кореневий каталог вашого проєкту та виконайте команди для перевірки версій:

   • Перевірити версію PHP: php -v
   • Перевірити версію Node.js: node -v
   • Перевірити версію Yarn: yarn -v
   • Перевірити версію NPM: npm -v
   • Перевірити версію Python: python -V або python3 -V
   • Перевірити версію Go: go version
   • Перевірити версію Java: java -version
   • Перевірити версію .NET: dotnet --version
   • Перевірити версію Ruby: ruby -v Зіставте вивід команди з тим, що зазначено у вашому .servbay.config.

3. Через веб-сторінку (актуально для PHP): Створіть у корені проєкту простий PHP-файл (наприклад, info.php) зі вмістом <?php phpinfo(); ?>. Відкрийте його в браузері (наприклад, http://your-project.servbay.demo/info.php) і перевірте у виводі версію PHP — вона має відповідати значенню в .servbay.config.

Нижче показано, як це може виглядати у додатку ServBay, коли проєктне налаштування активне:

(Будь ласка, орієнтуйтеся на фактичний інтерфейс та повідомлення ServBay для деталі застосування конфігурації.)

Важливі моменти

• Ім’я файлу .servbay.config має бути записане без помилок чи змін.
• Файл має бути в кореневій теці проєкту.
• Всі зазначені версії мають бути доступні та підтримувані у встановленому у вас ServBay.
• Кожна конфігурація задається окремим рядком у форматі КЛЮЧ=ЗНАЧЕННЯ.
• Помилки у синтаксисі можуть призвести до пропуску або ігнорування налаштувань.
• Параметри з .servbay.config мають пріоритет над глобальними й впливають лише на поточний проєкт.

Часті запитання (FAQ)

П: Що робити, якщо у корені мого проєкту немає файлу .servbay.config?

В: У цьому випадку ServBay використовуватиме глобальні налаштування середовища, задані у додатку для цього проєкту.

П: Що, якщо я вкажу у .servbay.config версію, яка не встановлена в ServBay?

В: ServBay повідомить про помилку; детальна поведінка залежить від конкретної версії додатку. Щоб уникнути проблем, завжди переконуйтеся, що потрібна версія встановлена через ServBay.

П: Чи потрібно перезапускати ServBay після зміни .servbay.config?

В: Зазвичай достатньо перезавантажити (зупинити й знову запустити) відповідний сайт у додатку ServBay, повний перезапуск додатку не потрібен.

П: Чи впливає налаштування у .servbay.config на інші мої проєкти?

В: Ні, конфігурація у .servbay.config діє лише у межах конкретного сайту/проєкту у ServBay.

Висновок

Файл .servbay.config надає розробникам потужний інструмент для управління проєктним середовищем у ServBay. Це дозволяє швидко перемикатися між різними версіями середовища для підтримки старих рішень або розробки нових проєктів на останньому стеку технологій. Завдяки цій простій конфігурації ви отримуєте чудову гнучкість та ізоляцію для локального розробницького оточення. Використовуйте цей механізм по максимуму — і ваш робочий процес стане ще простішим і ефективнішим!