README

运行 Symfony 所需的 Docker 环境（基于官方的 php 和 mysql Docker Hub 仓库）。

源代码

要求

Docker Engine 版本 18.06 或更高
Docker Compose 版本 1.22 或更高
一个编辑器或 IDE
MySQL Workbench

注意：操作系统推荐 - 基于 Ubuntu 的 Linux。

组件

Nginx 1.27
PHP 8.3 fpm
MySQL 8
Symfony 7
RabbitMQ 3
Mailpit（仅用于开发环境中的调试邮件）

设置 Docker Engine 和 Docker Compose

要安装带有 docker compose 的 Docker Engine，请遵循页面 Docker Engine 上的说明。

注意 1：如果您使用的是 Linux 操作系统，请在上述步骤之后运行以下命令：sudo usermod -aG docker $USER

注意 2：如果您使用的是 MacOS 12.2 或更高版本的 Docker Desktop，请启用 virtiofs 以提高性能（自 Docker Desktop v4.22 以来默认启用）。

设置开发环境

1.您可以从 GitHub 克隆此存储库或通过 composer 安装。

如果您已安装 composer 并想通过 composer 安装环境，可以使用以下命令：

composer create-project systemsdk/docker-nginx-php-symfony example-app

2.在 .env.prod 和 .env.staging 文件中为应用程序设置另一个 APP_SECRET。

注意 1：您可以在例如这里获取唯一的密钥。

注意 2：在开发和生产环境中不要使用 .env.local.php（如果存在，请删除它）。

注意 3：如果您想更改默认的 web 端口或 xdebug 配置，可以创建 .env.local 文件并设置一些参数（见 .env 文件）。

注意 4：如果存在，请删除 var/mysql-data 文件夹。

3.将域名添加到本地的 'hosts' 文件

127.0.0.1    localhost

4.配置 /docker/dev/xdebug-main.ini（Linux/Windows）或 /docker/dev/xdebug-osx.ini（MacOS）（可选）

如果您需要仅在前端 IDE KEY：PHPSTORM 的浏览器中调试请求

xdebug.start_with_request = no

在 Firefox 扩展程序 "Xdebug helper" 中安装本地，并在设置中设置 IDE KEY：PHPSTORM

如果您需要调试到 API 的任何请求（默认情况）

xdebug.start_with_request = yes

5.在终端构建、启动和安装 Docker 镜像

make build
make start
make composer-install

6.确保您已安装迁移 / 消息传递传输

make migrate
make messenger-setup-transports

7.为了使用此应用程序，请打开以下 URL 在您的浏览器中

在本地设置预发布环境

1.您可以从 GitHub 克隆此存储库或通过 composer 安装。

注意：如果存在，请删除 var/mysql-data 文件夹。

如果您已安装 composer 并想通过 composer 安装环境，可以使用以下命令：

composer create-project systemsdk/docker-nginx-php-symfony example-app

2.在终端构建、启动和安装 Docker 镜像

make build-staging
make start-staging

3.确保您已安装迁移 / 消息传递传输

make migrate-no-test
make messenger-setup-transports

在本地设置生产环境

1.您可以从 GitHub 克隆此存储库或通过 composer 安装。

如果您已安装 composer 并想通过 composer 安装环境，可以使用以下命令：

composer create-project systemsdk/docker-nginx-php-symfony example-app

2.编辑 compose-prod.yaml 并为 MySQL 和 RabbitMQ 设置必要的用户/密码。

注意：如果存在，请删除 var/mysql-data 文件夹。

3.编辑 env.prod 并为 MySQL 和 RabbitMQ 设置必要的用户/密码。

4.在终端构建、启动和安装 Docker 镜像

make build-prod
make start-prod

5.确保您已安装迁移 / 消息传递传输

make migrate-no-test
make messenger-setup-transports

进入容器获取 shell

应用程序启动（make start）后，为了获取 symfony 容器内部的 shell 访问权限，您可以运行以下命令

make ssh

注意 1：请使用以下 make 命令进入其他容器：make ssh-nginx、make ssh-supervisord、make ssh-mysql、make ssh-rabbitmq。

注意2：请使用 exit 命令从容器shell返回到本地shell。

构建容器

如果您编辑了Dockerfile或其他环境配置，您需要再次使用以下命令构建容器

make down
make build
make start

注意：如果您需要构建测试/预发布/生产环境，请使用特定于环境的命令，更多详细信息可以通过 make help 获取。

启动和停止环境容器

请使用以下make命令来启动和停止环境

make start
make stop

注意1：对于预发布环境，需要使用以下make命令：make start-staging，make stop-staging。

注意2：对于生产环境，需要使用以下make命令：make start-prod，make stop-prod。

停止并删除环境容器和网络

请使用以下make命令来停止并删除环境容器和网络

make down

注意：如果您需要停止并删除测试/预发布/生产环境，请使用特定于环境的命令，更多详细信息可以通过 make help 获取。

其他主要命令可用

make build
make build-test
make build-staging
make build-prod

make start
make start-test
make start-staging
make start-prod

make stop
make stop-test
make stop-staging
make stop-prod

make down
make down-test
make down-staging
make down-prod

make restart
make restart-test
make restart-staging
make restart-prod

make env-staging
make env-prod

make ssh
make ssh-root
make fish
make ssh-nginx
make ssh-supervisord
make ssh-mysql
make ssh-rabbitmq

make composer-install-no-dev
make composer-install
make composer-update

make info
make help

make logs
make logs-nginx
make logs-supervisord
make logs-mysql
make logs-rabbitmq

make drop-migrate
make migrate
make migrate-no-test

make fixtures

make messenger-setup-transports

make phpunit
make report-code-coverage

make phpcs
make ecs
make ecs-fix
make phpmetrics
make phpcpd
make phpmd
make phpstan
make phpinsights

etc....

注意：请参阅Makefile中的更多命令

架构与软件包

指南

处理您的项目

对于新功能开发，从 develop 分支创建一个新分支，并使用以下两种模式之一
- feature/{ticketNo}
经常提交，并编写描述性的提交消息，以便在审查时更容易跟踪步骤。
将此分支推送到仓库，并在 develop 中创建带有格式 feature/{ticketNo} - "Jira任务的简短描述性标题" 的拉取请求以获取反馈。
根据需要迭代。
请确保CircleCI（或如果您不使用CircleCI，则为另一个）上的“所有检查都已通过”，并且状态为绿色。
当PR被批准时，它将被压缩并合并到 develop 中，然后合并到 release/{No} 以进行部署。

注意：您可以在这里找到git flow详细示例。

许可证

MIT许可证（MIT）

systemsdk / docker-nginx-php-symfony

维护者

详细信息

README

要求

组件

设置 Docker Engine 和 Docker Compose

设置开发环境

在本地设置预发布环境

在本地设置生产环境

进入容器获取 shell

构建容器

启动和停止环境容器

停止并删除环境容器和网络

其他主要命令可用

架构与软件包

指南

处理您的项目

许可证