Установка

Сервер Symfony є частиною бінарності symfony, створеної, коли ви встановлюєте Symfony, і має підтримку для Linux, macOS і Windows.

Початок роботи

Сервер Symfony запускається один раз у проекті, тому у вас може вийти декілька екземплярів (кожний з них слухатиме різні порти). Ось типовий робочий процес обслуговування проекту Symfony:

1
2
3
4
5
6
7
8

$ cd my-project/
$ symfony server:start

  [OK] Web server listening on http://127.0.0.1:....
  ...

# Тепер, перейдіть по заданому URL або виконайте цю команду:
$ symfony open:local

Запуск сервера таким чином може відобразити повідомлення логу у консолі, тому ви не зможете виконувати інші команди одночасно. Якщо ви хочете, ви можете запустити сервер Symfony фоново:

1
2
3
4
5
6
7
8
9

$ cd my-project/

# запустіть сервер фоново
$ symfony server:start -d

# продовжуйте працювати та виконувати інші команди...

# покажіть останні повідомлення логу
$ symfony server:log

1

$ sudo codesign --force --deep --sign - $(whereis -q symfony)

Підключення PHP-FPM

Коли сервер запускається, він перевіряє web/index_dev.php, web/index.php, public/app_dev.php, public/app.php у такому порядку. Якщо знайдено один з них, сервер автоматично запуститься з підключеним PHP-FPM. В інших випадках, сервер запуститься без PHP-FPM і відобразить сторінку Сторінка не знайдена, при спробі отримати доступ до файлу .php у браузері.

Підключення TLS

Локальний перегляд безпечної версії ваших додатків важливий для того, щоб виявити проблеми зі змішаним змістом якомога раніше, і щоб запускати бібліотеки, що працюють лише на HTTPS. За традицією, це було боляче та складно налаштовувати, але сервер Symfony все автоматизує. Спочатку виконайте команду:

1

$ symfony server:ca:install

Ця команда створює локальний авторитет сертифікату, реєструє його у вашому сховищі довіри системи у Firefox (необхідно лише для цього браузера), і створює сертифікат за замовчуванням для localhost і 127.0.0.1. Іншими словами, вона робить за вас все.

До перегляду вашого локального додатку з HTTPS замість HTTP, перезапустіть його сервер, зупинивши та запустивши його знову.

Різні PHP-налаштування для кожного проекту

1
2
3
4
5
6
7

$ cd my-project/

# використовувати конкретну версію PHP
$ echo 7.4 > .php-version

# використовувати будь-яку доступну версію PHP 8.x
$ echo 8 > .php-version

1
2
3
4
5

$ symfony local:php:list

  # Ви побачите всі підтримувані SAPI (CGI, FastCGI, та ін.) для кожної версії.
  # FastCGI (php-fpm) використовується там, де можливо; потім CGI (який також діє як
  # сервер FastCGIserver), і, нарешті, сервер відкочується до звичайного CGI.

1
2
3
4
5
6

$ cd my-project/

# цей проект перевизначає лише часовий пояс PHP за замовчуванням
$ cat php.ini
[Date]
date.timezone = Asia/Tokyo

1
2
3
4
5
6

# виконує команду з версією PHP за замовчуванням
$ php -r "..."

# виконує команду з верією PHP, обраною проектом
# (або верією PHP за замовчуванням, якщо проект не обирав версію)
$ symfony php -r "..."

Імена локальних доменів

За замовчуванням, проекти доступні з довільного порту локального IP 127.0.0.1. Однак, іноді лучше асоціювати з ними імʼя домену:

• Це зручніше, коли ви безперервно працюєте над одним проектом, так як номери портів можуть змінюватися, а домени - ні;
• Поведінка деяких додатків залежить від їх доменів/субдоменів;
• Наявність стабільних кінцевих точок, на кшталт локального перенаправлення URL для OAuth2.

1

$ symfony proxy:start

1
2

$ cd my-project/
$ symfony proxy:domain:attach my-domain

1

$ symfony proxy:domain:attach "*.my-domain"

1
2
3
4
5
6
7
8

# Приклад з curl
$ https_proxy=$(symfony proxy:url) curl https://my-domain.wip

# Приклад з  Blackfire та curl
$ https_proxy=$(symfony proxy:url) blackfire curl https://my-domain.wip

# Приклад з  Cypress
$ https_proxy=$(symfony proxy:url) ./node_modules/bin/cypress open

Довгострокові команди

Довгострокові команди, так як ті, що компілюють фронтенд веб-ресурси, блокують термінал, і ви не можете виконувати інші команди у той же час. Сервер Symfony надає команду run, щоб огорнути їх наступним чином:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# скомпілюйте ресурси Webpack, використовуючи Symfony Encore ... але зробіть це
# фоново, щоб не блокувати термінал
$ symfony run -d yarn encore dev --watch

# продовжуйте працювати та виконувати інші команди...

# час від часу перевіряйте логи команд, якщо хочете
$ symfony server:log

# і ви також можете перевірити, чи виконується ще команда
$ symfony server:status
Web server listening on ...
Command "yarn ..." running with PID ...

# зупиніть веб-сервер (і всі асоційовані команди), коли ви закінчите
$ symfony server:stop

Файл конфігурації

Існує декілька опцій, які ви можете встановити, використовуючи файл конфігурації .symfony.local.yaml:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# Встановлює domain1.wip і domain2.wip для поточного проекту
proxy:
    domains:
        - domain1
        - domain2

http:
    document_root: public/ # Шлях до кореню документа проекту
    passthru: index.php # Індекс passthru проекту
    port: 8000 # Форсувати порт, який буде використано для запуску сервера
    preferred_port: 8001 # Бажаний порт HTTP [за замовчуванням: 8000]
    p12: path/to/p12_cert # Імʼя файлу, що містить сертифікат TLS, для використання у форматі p12
    allow_http: true # Запобігти авто-перенаправленню з HTTP на HTTPS
    no_tls: true # Використати HTTP замість HTTPS
    daemon: true # Запустити сервер у фоновому режимі
    use_gzip: true # Увімкнути стискання GZIP

Конфігурація робітників

Якщо ви хочете, щоб якісь процеси запускалися автоматично, разом з веб-сервером (symfony server:start), додайте файл конфігурації у ваш проект:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# .symfony.local.yaml
workers:
    # вбудована команда, яка будує та споглядає за ресурсами фронтенду
    # yarn_encore_watch:
    #     cmd: ['yarn', 'encore', 'dev', '--watch']
    yarn_encore_watch: ~

    # вбудована команда, яка запускає споживача месенджера
    # messenger_consume_async:
    #     cmd: ['symfony', 'console', 'messenger:consume', 'async']
    #     watch: ['config', 'src', 'templates', 'vendor']
    messenger_consume_async: ~

    # ви також можете додати власні користувацькі команди
    build_spa:
        cmd: ['yarn', '--cwd', './spa/', 'dev']

Інтеграція Docker

Локальний сервер Symfony надає повну інтеграцію Docker для проектів, які її використовують. Щоб дізнатися більше про Docker і Symfony, див. Використання Docker з Symfony.

Коли веб-сервер визначає, що для проекту запущено Docker Compose, він автоматично демонструє деякі змінні середовища.

Через API docker-compose, він шукає розкриті порти, використовувані для розповсюджених сервісів. Коли він виявляє той, про який знає, він використовує імʼя сервісу, щоб продемонструвати змінні середовища.

Розгляньте наступну конфігурацію:

1
2
3
4

# docker-compose.yaml
services:
    database:
        ports: [3306]

Веб-сервер визначає, що сервіс, що розкриває порт 3306 працює для проекту. Він розуміє, що це - сервіс MySQL, і створює змінні середовища відповідно до імені сервісу (database) в якості префіксу: DATABASE_URL, DATABASE_HOST, ...

Якщо сервіс не знаходиться у списку підтримуваних нижче, встановлюються загальні змінні середовища: PORT, IP, и HOST.

Якщо імена docker-compose.yaml не співпадають з угодами Symfony, додайте ярлик, щоб перевизначити префікс змінних середовища:

1
2
3
4
5
6

# docker-compose.yaml
services:
    db:
        ports: [3306]
        labels:
            com.symfony.server.service-prefix: 'DATABASE'

У цьому прикладі сервіс називається db, тому змінні середовища матимуть префікс DB_, але так як com.symfony.server.service-prefix встановлено як DATABASE, веб-сервер створює змінні середовища, що починаються з DATABASE_ замість того, що очікується конфігурацією Symfony за замовчуванням.

Ось список всіх підтримуваних сервісів з їх портами та префіксом Symfony за замовчуванням:

Ви можете відкрити інтерфейси веб-управління для сервісів, які їх демонструють:

1
2

$ symfony open:local:webmail
$ symfony open:local:rabbitmq

Або натиснути на посилання у розділі "Server" в панелі інструментів веб-налагодження.

Коли запущені сервіси Docker, перейдіть на сторінку вашого додатку Symfony та перевірте розділ "Symfony Server" в панелі інструментів веб-налагодження; ви побачите, що "Docker Compose" - "Up".

1
2
3
4
5
6

# docker-compose.yaml
services:
    db:
        ports: [3306]
        labels:
            com.symfony.server.service-ignore: true

Якщо ваш файд Docker Compose не знаходиться у корені проекту, використайте змінні середовища COMPOSE_FILE і COMPOSE_PROJECT_NAME, щоб визначити його місцезнаходження, так само, як для docker-compose:

1
2
3
4
5

# запустіть ваші контейнери:
COMPOSE_FILE=docker/docker-compose.yaml COMPOSE_PROJECT_NAME=project_name docker-compose up -d

# запустіть будь-яку команду Symfony CLI:
COMPOSE_FILE=docker/docker-compose.yaml COMPOSE_PROJECT_NAME=project_name symfony var:export

Інтеграція Platform.sh

Локальний сервер Symfony надає повну, але не обовʼязкову, інтеграцію з Platform.sh - сервісом, оптимізованим для запуску ваших додатків Symfony у хмарів. Він надає такі функції як створення середовищ, бекапів/ миттєвих знімків, і навіть доступ до копії даних виробництва з вашої локальної машини, щоб допомогти з налагодженням будь-яких проблем.

Прочитайте технічні документи SymfonyCloud.