【补充】docker-compose部署Yapi

发布时间 2023-07-31 21:56:05作者: Chimengmeng

【补充】docker-compose部署Yapi

参考博客:docker-compose部署Yapi - 知乎 (zhihu.com)

【1】了解Docker Compose:

  • Docker Compose是Docker官方推出的一个用于定义和运行多个Docker容器的工具。
  • 通过使用Docker Compose,你可以使用一个单独的yaml文件来定义多个相关的服务,然后使用一条命令即可启动、停止和管理这些服务。

【2】准备Docker Compose文件:

  • 首先,你需要创建一个名为docker-compose.yml的文件,并在其中定义Yapi的Docker镜像、容器名称、端口映射以及其他相关配置。
  • 一个示例的docker-compose.yml文件如下所示:
version: '3'
services:
  yapi:
    container_name: yapi
    image: "ym/ym-yapi:latest"
    ports:
      - "3000:3000"
    volumes:
      - /yapi/config:/yapi/vendors
  • 在上面的示例中,我们定义了一个名为yapi的service,使用了Yapi的Docker镜像"ym/ym-yapi:latest"。
  • 我们将主机的3000端口映射到容器的3000端口,以便可以访问Yapi的Web界面。
  • 并通过卷挂载,将主机的/yapi/config目录映射到容器的/yapi/vendors目录,以便持久化保存配置文件。

【3】执行Docker Compose命令:

  • 在准备好docker-compose.yml文件后,在命令行中进入该文件所在的目录,并执行以下命令来启动Yapi服务:
docker-compose up -d
  • 该命令会根据docker-compose.yml文件的定义,启动Yapi服务。参数"-d"表示以守护进程方式运行,即在后台运行。

【4】访问Yapi Web界面:

  • 一旦Yapi容器启动成功,你就可以通过浏览器访问Yapi的Web界面。
  • 在上面的示例中,你可以通过访问"http://localhost:3000"来访问Yapi。

【5】注意事项:

  • 在执行docker-compose命令之前,确保已经安装了Docker和Docker Compose,并拥有执行权限。
  • 在Docker Compose文件中,可以定义其他依赖服务,比如数据库等,并且可以按照需要进行配置。
  • 根据实际情况,你可能需要修改Docker镜像的名称和版本号,并调整端口映射和卷挂载的路径。

【6】总结来说

  • 使用Docker Compose部署Yapi可以简化整个部署过程,提高部署效率并保证环境一致性。
  • 通过合理的配置和管理,可以轻松地启动和停止Yapi服务,并通过Web界面进行操作和管理。