wayofdev/nginx

Docker镜像：Nginx

此Docker镜像提供了精简的Nginx设置，针对本地PHP开发环境进行了优化。

它旨在与https://github.com/wayofdev/docker-php-dev%E5%8F%8A%E5%85%B6%E4%BB%96(WOD)%E9%95%9C%E5%83%8F%E6%97%A0%E7%BC%9D%E9%9B%86%E6%88%90%EF%BC%8C%E4%B8%BAWeb%E9%A1%B9%E7%9B%AE%E6%9E%84%E5%BB%BA%E9%AB%98%E6%95%88%E7%9A%84%E6%9C%AC%E5%9C%B0%E5%BC%80%E5%8F%91%E7%94%9F%E6%80%81%E7%B3%BB%E7%BB%9F%E3%80%82

🌟 为何选择此镜像进行本地开发？

• 基于Ansible的配置：通过Ansible模板轻松自定义配置
• 优化PHP-FPM：预配置用于PHP-FPM，支持快速本地测试和开发
• SSL就绪：内置HTTPS支持（使用自签名证书），在本地模拟生产环境
• 开发者友好：内置工具和配置，提升本地开发工作流
• 灵活部署：包含k8s-alpine变体，用于在本地测试Kubernetes设置
• 轻量级：基于Alpine Linux，占用资源少，本地构建速度快
• 多架构支持：支持x86（AMD64） 和ARM64架构，适配多种开发设备
• 定期更新：持续维护和更新，与最新开发实践保持一致

适用于开发Laravel应用、Symfony项目或任何PHP-based Web服务，在本地环境中构建接近生产环境的开发环境。

提供创建、测试和调试Web应用的本地基础环境。

如果您喜欢/使用此镜像，请考虑⭐️为其加星。感谢！

📦 镜像变体

🚀 使用方法

→ 拉取镜像

bash
docker pull wayofdev/nginx:k8s-alpine-latest

将k8s-alpine-latest替换为您需要的类型和标签。

→ 可用镜像变体

• 类型：k8s、dev
• 架构：amd64、arm64

→ 在Docker Compose中使用

以下是典型设置的docker-compose.yml示例：

yaml
services:
  app:
    image: wayofdev/php-dev:8.3-fpm-alpine-latest
    container_name: ${COMPOSE_PROJECT_NAME}-app
    restart: on-failure
    networks:
      - default
      - shared
    depends_on:
      - database
    links:
      - database
    volumes:
      - ./.github/assets:/assets:rw,cached
      - ./app:/app:rw,cached
      - ./.env:/app/.env
      - ~/.composer:/.composer
      - ~/.ssh:/home/www-data/.ssh
    environment:
      FAKETIME: '+2h'
      XDEBUG_MODE: '${XDEBUG_MODE:-off}'
      PHIVE_HOME: /app/.phive
    dns:
      - 8.8.8.8
    extra_hosts:
      - 'host.docker.internal:host-gateway'

  web:
    image: wayofdev/nginx:k8s-alpine-latest
    container_name: ${COMPOSE_PROJECT_NAME}-web
    restart: on-failure
    networks:
      - default
      - shared
    depends_on:
      - app
    links:
      - app
    volumes:
      - ./app:/app:rw,cached
      - ./.env:/app/.env
    labels:
      - traefik.enable=true
      - traefik.http.routers.api-${COMPOSE_PROJECT_NAME}-secure.rule=Host(`api.${COMPOSE_PROJECT_NAME}.docker`)
      - traefik.http.routers.api-${COMPOSE_PROJECT_NAME}-secure.entrypoints=websecure
      - traefik.http.routers.api-${COMPOSE_PROJECT_NAME}-secure.tls=true
      - traefik.http.services.api-${COMPOSE_PROJECT_NAME}-secure.loadbalancer.server.port=8880
      - traefik.docker.network=network.${SHARED_SERVICES_NAMESPACE}

此配置包含

• 使用wayofdev/php-dev镜像的app服务，用于PHP处理。
• 使用https://github.com/wayofdev/docker-nginx%E7%9A%84%60web%60%E6%9C%8D%E5%8A%A1%EF%BC%8C%E7%94%A8%E4%BA%8E%E6%8F%90%E4%BE%9B%E5%BA%94%E7%94%A8%E8%AE%BF%E9%97%AE%E3%80%82
• 默认网络和共享网络的配置。
• 应用代码、资源和配置文件的卷挂载。
• PHP和Xdebug配置的环境变量。
• 用于反向代理和SSL终止的Traefik标签。

实际示例

有关如何在Docker Compose设置中使用此镜像的全面实际示例，请参考https://github.com/wayofdev/laravel-starter-tpl%E4%BB%93%E5%BA%93%E3%80%82%E8%AF%A5%E6%A8%A1%E6%9D%BF%E4%B8%BALaravel%E9%A1%B9%E7%9B%AE%E6%8F%90%E4%BE%9B%E4%BA%86%E4%BD%BF%E7%94%A8%60wayofdev/php-dev%60%E9%95%9C%E5%83%8F%E7%9A%84%E5%AE%8C%E6%95%B4%E9%85%8D%E7%BD%AE%E5%BC%80%E5%8F%91%E7%8E%AF%E5%A2%83%E3%80%82

⚙️ 配置

Nginx镜像预配置为针对PHP应用的最佳性能，但您可以根据具体需求进一步自定义。

→ 默认配置

默认配置通过Ansible模板生成，包括：

• 针对PHP-FPM的优化设置
• 支持SSL/TLS的自签名证书
• 启用Gzip压缩
• 基本安全头

→ 自定义配置

虽然配置主要通过Ansible模板管理，但您可以通过以下方式进一步自定义：

1. 环境变量：镜像使用以下环境变量：

   变量	默认值	描述
   PHP_UPSTREAM_CONTAINER	app	PHP-FPM容器名称
   PHP_UPSTREAM_PORT	9000	PHP-FPM容器端口

   在docker-compose.yml中设置这些变量：

   yaml
   services:
     web:
       image: wayofdev/nginx:k8s-alpine-latest
       environment:
         - PHP_UPSTREAM_CONTAINER=my-php-app
         - PHP_UPSTREAM_PORT=9001
   

2. 卷挂载：如需更广泛的自定义，可挂载自己的配置文件：

   yaml
   services:
     web:
       image: wayofdev/nginx:k8s-alpine-latest
       volumes:
         - ./custom-nginx.conf:/etc/nginx/nginx.conf
         - ./custom-default.conf:/etc/nginx/conf.d/default.conf
   

→ SSL配置

镜像包含自签名SSL证书。如需使用自己的证书：

yaml
services:
  web:
    image: wayofdev/nginx:k8s-alpine-latest
    volumes:
      - ./certs/cert.pem:/etc/nginx/ssl/cert.pem
      - ./certs/key.pem:/etc/nginx/ssl/key.pem

→ 高级配置

如需高级配置：

1. Fork此仓库
2. 修改src目录中的Ansible模板
3. 使用make generate重新生成Dockerfiles
4. 构建自定义镜像

🔨 开发

该项目使用一系列工具进行开发和测试。Makefile提供了简化开发流程的各种命令。

→ 依赖要求

• Docker
• Make
• Ansible
• goss和dgoss（用于测试）

→ 设置开发环境

克隆仓库：

bash
git clone git@github.com:wayofdev/docker-nginx.git && \
cd docker-nginx

→ 生成Dockerfiles

Ansible用于生成Dockerfiles和配置。从Jinja模板源代码生成可分发的Dockerfiles：

bash
make generate

→ 构建镜像

• 构建默认镜像：

  bash
  make build
  

  此命令构建Makefile中IMAGE_TEMPLATE变量指定的镜像。默认设置为k8s-alpine。

• 构建特定镜像：

  bash
  make build IMAGE_TEMPLATE="k8s-alpine"
  

  将8.3-fpm-alpine替换为所需的PHP版本、类型和操作系统。

• 构建所有镜像：

  bash
  make build IMAGE_TEMPLATE="k8s-alpine"
  make build IMAGE_TEMPLATE="dev-alpine"
  

  这些命令将构建所有支持的镜像变体。

🧪 测试

该项目采用测试方法确保Docker镜像的质量和功能。主要测试工具是https://github.com/aelsabbahy/goss/tree/master/extras/dgoss%EF%BC%8C%E7%94%A8%E4%BA%8E%E6%B5%8B%E8%AF%95Docker%E5%AE%B9%E5%99%A8%E3%80%82

→ 运行测试

可使用以下命令运行测试：

• 测试默认镜像：

  bash
  make test
  

  此命令测试Makefile中IMAGE_TEMPLATE变量指定的镜像（默认是k8s-alpine）。

• 测试特定镜像：

  bash
  make test IMAGE_TEMPLATE="k8s-alpine"
  

  将k8s-alpine替换为所需的镜像类型和操作系统。

• 测试所有镜像：

  bash
  make test IMAGE_TEMPLATE="k8s-alpine"
  make test IMAGE_TEMPLATE="dev-alpine"
  

→ 测试配置

测试配置在每个镜像变体的goss.yaml文件中定义，指定要运行的测试，包括：

• 文件存在性和权限
• 进程检查
• 端口可用性
• 包安装情况
• 命令输出

→ 测试流程

运行make test命令时，将执行以下步骤：

1. 构建指定的Docker镜像（如果尚未存在）。
2. dgoss针对Docker容器运行goss.yaml中定义的测试。
3. 测试结果显示在控制台中。

🔒 安全策略

该项目有安全策略。

🙌 贡献指南

感谢您考虑为wayofdev社区做出贡献！我们欢迎各种形式的贡献。如果您想：

• 🤔 https://github.com/wayofdev/docker-nginx/issues/new?assignees=&labels=type%3A+enhancement&projects=&template=2-feature-request.yml&title=%5BFeature%5D%3A+
• 🐛 https://github.com/wayofdev/docker-nginx/issues/new?assignees=&labels=type%3A+documentation%2Ctype%3A+maintenance&projects=&template=1-bug-report.yml&title=%5BBug%5D%3A+
• 📖 https://github.com/wayofdev/docker-nginx/issues/new?assignees=&labels=type%3A+documentation%2Ctype%3A+maintenance&projects=&template=4-docs-bug-report.yml&title=%5BDocs%5D%3A+
• 👨‍💻 代码贡献

欢迎参与。贡献前，请查阅我们的贡献指南。

![Conventional Commits]([***]

🫡 贡献者

https://github.com/wayofdev/docker-nginx/graphs/contributors

🌐 社交链接

• *******：关注我们的组织@wayofdev和作者@wlotyp。
• *****：加入我们的*社区。

⚖️ 许可证