docker for magento 2.x

为 Magento 2.4 准备的docker环境，可能2.3也能用

寻找 Magento 1.x 的docker环境？点这里

功能

1. 支持 https
2. 支持 一台服务器上多人开发环境分离
3. 支持 ssh / sftp 方式开发
4. 支持 code-server 浏览器方式开发

安装步骤

1. 安装环境 安装 docker & docker-compose，参见docker 官方文档
   https://docs.docker.com/install/linux/docker-ce/ubuntu/
   https://docs.docker.com/compose/install/#master-builds

2. 创建项目文件夹，下载代码

   1. 创建文件夹

      目录结构见附录

      # 项目文件夹
      mkdir -p magento-domain-2/ && cd $_
      # mkdir mysql57 magento2
      # mkdir magento2/ # <------ 此magento2文件夹名对应.env文件的`APPLICATION`值
      # mkdir mysql57/ # <------ 此magento2文件夹名对应.env文件的`DB_DIR`值

   2. 准备 magento2 源码
      解压源码到 magento2/文件夹下

      # 例如
      git clone git@github.com/xxxx/xxxx.git magento2/
      

   3. 克隆 docker-magento2.x

      cd magento-domain-2/
      git clone https://github.com/goodwong/docker-magento2.x .docker/

   4.（可选）初始化数据库文件（可选，也可以在后面步骤手工导入） 将 数据库备份文件 .sh, .sql 或 .sql.gz 文件放到 .docker/db/initdb.d/目录下

3. 配置

   1. docker-magento

      cd .docker/
      cp .env.example .env

      默认配置即可运行，如果有多个magento站点运行，分别修改以下变量为不同的值：

      • COMPOSE_PROJECT_NAME=
      • NGINX_HOST_HTTP_PORT=
      • DB_ADMINER_PORT=
      • WORKSPACE_SSH_PORT=
      • WORKSPACE_CODER_PORT=

      生产环境下， 务必修改 数据库密码

      • DB_ROOT_PASSWORD=
      • DB_PASSWORD=
      • DB_USER=
      • DB_NAME=

   2. 创建/修改 magento2/app/etc/env.php，修改 db 连接参数

      <?php
      return [
          'db' => [
              'table_prefix' => '',
              'connection' => [
                  'default' => [
                      'host' => 'db',
                      'dbname' => 'app',
                      'username' => 'app',
                      'password' => 'secret',

   3. 创建 host nginx 的 site 配置（参见附录）

4. 启动

   1. 启动服务

      cd .docker/
      # ！！提示
      # 请确保 magento2/目录下 有nginx.conf.sample文件，否则 容器内的 nginx 起不来
      docker-compose up -d web workspace
      
      # 查看日志
      docker-compose logs -f

   2. 验证并重启 nginx

      nginx -t
      service nginx reload
      

   3. 更新 letsencrypt

      sudo certbot --nginx -d dev-xxx.xxx.com
      

   4. 文件权限设置

      cd magento2/ # 宿主机
      find var generated vendor pub/static pub/media app/etc -type f -exec chmod g+w {} +
      find var generated vendor pub/static pub/media app/etc -type d -exec chmod g+ws {} +
      chown -R :www-data .
      chmod u+x bin/magento

      更多参考：
      https://devdocs.magento.com/guides/v2.4/install-gde/prereq/file-system-perms.html#perms-private

      提示2：
      代码文件的 ownner 应该是 vscode，group 是 www-data
      但是 var/cache | var/session 需要保持 ownner 为 www-data，否则会报错
      所以，首次 git clone 后，可以 chown -R vscode:www-data，中途尽量是改哪个文件就设置那个文件的权限。

   5. 安装包依赖

      docker-compose exec workspace bash
      
      # 预设 magento api token
      mkdir ~/.composer; echo '{"http-basic": {"repo.magento.com":{"username":"____","password":"____"}}}' > ~/.composer/auth.json
      # 或者安装过程中会要求输入 key 和密码
      
      # 开始安装
      composer install

5. （可选）导入数据

   1. 复制数据库到 mysql57/ 文件夹
   2. 导入数据库

      docker-compose exec -w /var/lib/mysql/ db bash 
      mysql -p app < database_backup_file.sql

   3. 重新编译

      rm -rf pub/static/*  # 这个很重要，不然主题会出不来
      php bin/magento setup:di:compile
      php bin/magento cache:clean
      php bin/magento setup:upgrade
      php bin/magento setup:static-content:deploy

   4. 修改 base_url

      docker-compose exec workspace bash
      
      BASE_URL=https://dev-xxx.app.com
      php bin/magento setup:store-config:set --base-url-secure="${BASE_URL}"
      php bin/magento setup:store-config:set --base-url="${BASE_URL}" # 这条也要，不然后台无法访问报404
      php bin/magento cache:flush

附录

• 文件夹结构

  magento-domain-2/
  ├── .docker/ # <---- docker-compose 配置及数据文件夹
  │   ├── .env
  │   ├── adminer/
  │   ├── cron/
  │   ├── docker-compose.yml
  |   ....
  |
  ├── mysql57/ # <------------ mysql 数据库文件
  │   ├── auto.cnf
  |   ....
  |
  └── magento2/ # <----------- magento 2.x 代码文件夹
      ├── app/
      ├── auth.json.sample
      ├── bin/
      ....
      ├── var/
      └── vendor/

• 使用 magento命令行

  # 登陆workspace容器
  docker-compose up -d workspace
  docker-compose exec workspace bash
  
  # 执行安装
  magento setup:install \
  --admin-firstname=William --admin-lastname=Wong \
  --admin-email=goodwong@foxmail.com --admin-user=admin --admin-password=******** \
  --db-host=db --db-name=app --db-user=app --db-password=app
  
  # 执行magento命令：
  magento cache:status
  
  # 执行composer命令
  composer list

  参见 https://devdocs.magento.com/guides/v2.0/install-gde/install/cli/install-cli-install.html

• 导入/管理数据库

  有两种方式管理数据库：

  • 方法一，通过adminer的web界面操作

    cd .docker/
    docker-compose up adminer

    打开浏览器 http://IP地址:<DB_ADMINER_PORT>?server=db

  • 方法二，进入mysql容器，使用命令行界面
    首先将数据文件解压并放在 数据库文件夹下（如:magento-domain-2/mysql57/）

    # 登陆db容器
    docker-compose exec -w /var/lib/mysql/ db bash 
    mysql -p db_name < database_backup_file.sql
    #           ^                ^
    #        数据库名         数据库备份文件
    #       见.env文件
    
    # 方式2：创建新容器，可以自由挂载当前目录
    docker-compose run --rm -v `pwd`:/wsp -w /wsp db bash
    mysql -h db -u app -p # 这里要指定host
    mysqldump -h db -u root -p app > app.sql # 这里要指定host
    

• CRON

  请确保Magento正确安装后，再启用本服务

  cd .docker/
  docker-compose up -d cron

• nginx 站点配置

  注意分别修改.env文件里端口变量为不同的值

  建议使用nginx作前端机，配置代理规则

  # 宿主机
  # ／etc/nginx/sites-available/domain-1.conf
  
  server {
  
      server_name dev-xxx.xxx.com;
  
      location /code-server/ {
          proxy_set_header HOST $host;
          proxy_set_header Upgrade $http_upgrade;
          proxy_set_header Connection upgrade;
          proxy_set_header Accept-Encoding gzip;
  
          proxy_pass http://127.0.0.1:8003/; # <--- 末尾必须有/符号
                                             # <--- 端口号见<WORKSPACE_CODER_PORT> 变量
      }
  
      location / {
          # 解决 upstream sent too big header while reading response header from upstream 的问题
          proxy_buffer_size       128k;
          proxy_buffers           32 32k;
          proxy_busy_buffers_size 128k;
  
          proxy_set_header HOST $host;
          proxy_set_header X-Forwarded-Proto $scheme;
          proxy_set_header X-Real-IP $remote_addr;
          proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  
          proxy_pass http://127.0.0.1:7700/; # <--- 末尾必须有/符号
                                             # <--- 端口号见<NGINX_HOST_HTTP_PORT> 变量
      }
  
  }