From 385d31af939731f484754715545e9558c41aa095 Mon Sep 17 00:00:00 2001 From: mlogclub Date: Tue, 17 Sep 2024 10:16:32 +0800 Subject: [PATCH] update docker start doc --- docs/getstart/docker.md | 92 +++++++---------------------------------- 1 file changed, 16 insertions(+), 76 deletions(-) diff --git a/docs/getstart/docker.md b/docs/getstart/docker.md index 5e6bd0b..8207f58 100644 --- a/docs/getstart/docker.md +++ b/docs/getstart/docker.md @@ -4,91 +4,31 @@ 本安装流程介绍的是如何使用Docker快速安装bbs-go,在安装之前请确保您已经正确安装并启动Docker服务 ::: -安装步骤如下: +## Clone代码 -1. 在你的电脑上创建目录,创建目录 `bbs-go-docker`,并进入该目录 -2. 准备SQL初始化脚本 -在`bbs-go-docker`目录中创建文件:`.docker-compose/mysql/docker-entrypoint-initdb.d/init.sql`,该文件为SQL初始化脚本。SQL脚本内容请加QQ群获取: +进入项目主页 [https://github.com/mlogclub/bbs-go](https://github.com/mlogclub/bbs-go),使用git,将代码clone到本地。 -![](/images/qq.png) +## 启动服务 -3. 创建`docker-compose.yml`文件 - -```yml -version: '3.8' - -services: - mysql: - container_name: bbs-go-mysql - image: 'mysql:8.0' - environment: - TZ: Asia/Shanghai - MYSQL_DATABASE: bbsgo_db - MYSQL_USER: bbsgo - MYSQL_PASSWORD: 123456 - MYSQL_ROOT_PASSWORD: 123456 - volumes: - - .docker-compose/mysql/docker-entrypoint-initdb.d:/docker-entrypoint-initdb.d # 初始化脚本件目录, 这个目录中的.sh/sql文件会以字母顺序依次执行 - # - ./mysql:/var/lib/mysql # 挂载数据件目录.如果非root账号执行,挂载目录必须是登录账号下目录 - # - .docker-compose/mysql/conf.d:/etc/mysql/conf.d # 挂在配置文件目录 - restart: always - healthcheck: - test: '/usr/bin/mysql --user=bbsgo --password=123456 bbsgo_db --execute "SHOW TABLES;"' - interval: 3s - timeout: 300s - retries: 100 - command: --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci - - server: - container_name: bbs-go-server - image: mlogclub/bbs-go-server:latest - depends_on: - mysql: - condition: service_healthy - - ports: - - 8082:8082 - build: - dockerfile: Dockerfile - context: ./server - volumes: - - /data/docker:/data - restart: on-failure +::: warning 📢注意 +启动服务会使用到端口`3000`和`8082`,请确保你的机器上这两个端口未被占用。 +::: - site: - container_name: bbs-go-site - image: mlogclub/bbs-go-site:latest - depends_on: - - server - ports: - - 3000:3000 - build: - dockerfile: Dockerfile - context: ./site - restart: on-failure +进入代码目录,执行`docker-compose up`命令启动服务 +如果你没有权限执行docker-compose命令,你可能需要用到sudo,尝试使用命令`sudo docker-compose up` - admin: - container_name: bbs-go-admin - image: mlogclub/bbs-go-admin:latest - depends_on: - - server - ports: - - 8080:80 - build: - dockerfile: Dockerfile - context: ./admin - restart: on-failure +此命令将下载所需的Docker镜像(如果本地不存在),并启动容器。 -``` +## 访问服务 -4. 使用`docker-compose up`命令启动启动服务 +服务启动成功后,在浏览器中访问下面路径即可成功访问服务: -> 如果你没有权限执行docker-compose命令,你可能需要用到sudo +> 如果你是在本地启动的docker服务,可以直接使用下面链接访问。如果你在其他机器上启动的,请根据实际情况调整访问地址,并确保启动服务的机器网络和端口对外开放。 -此命令将下载所需的Docker镜像(如果本地不存在),并启动容器。 +- 前台: [http://localhost:3000](http://localhost:3000) +- 后台: [http://localhost:3000/admin](http://localhost:3000/admin) -5. 服务启动成功,可通过浏览器访问服务,服务地址如下: +## docker启动进阶配置 -- 前台: [http://localhost:3000](http://localhost:3000) -- 后台: [http://localhost:8080](http://localhost:8080) +上述文档讲解的启动流程是使用`docker-compose`启动的,所以想要了解更多配置信息可以查看项目根目录中的`docker-compose.yml`。