From bc7c1ba1b076efff70adefda9dfb3af53d79fbc3 Mon Sep 17 00:00:00 2001 From: chenos Date: Mon, 5 Dec 2022 22:59:10 +0800 Subject: [PATCH] feat: update docs --- .github/workflows/docker-hub.yml | 2 -- Dockerfile | 2 +- Dockerfile.acr | 2 +- docker/app-mysql/docker-compose.yml | 2 +- docker/app-postgres/docker-compose.yml | 2 +- docker/app-sqlite/docker-compose.yml | 2 +- .../installation/docker-compose.md | 8 +++-- .../upgrading/docker-compose.md | 28 ++---------------- .../installation/docker-compose.md | 8 +++-- .../upgrading/docker-compose.md | 29 ++++--------------- 10 files changed, 23 insertions(+), 62 deletions(-) diff --git a/.github/workflows/docker-hub.yml b/.github/workflows/docker-hub.yml index b608a8701..ed6322d71 100644 --- a/.github/workflows/docker-hub.yml +++ b/.github/workflows/docker-hub.yml @@ -4,8 +4,6 @@ on: push: branches: - 'main' - paths: - - 'packages/**' jobs: push-docker: diff --git a/Dockerfile b/Dockerfile index 11879fa6d..f10ec3c5e 100644 --- a/Dockerfile +++ b/Dockerfile @@ -7,7 +7,7 @@ WORKDIR /tmp COPY . /tmp RUN npx npm-cli-adduser --username test --password test -e test@nocobase.com -r $VERDACCIO_URL RUN cd /tmp && \ - NEWVERSION="$(cat lerna.json | jq '.version' | tr -d '"').$(date +%s)" \ + NEWVERSION="$(cat lerna.json | jq '.version' | tr -d '"').$(date +'+%Y%m%d%H%M%S')" \ && tmp=$(mktemp) \ && jq ".version = \"${NEWVERSION}\"" lerna.json > "$tmp" && mv "$tmp" lerna.json RUN yarn install && yarn build diff --git a/Dockerfile.acr b/Dockerfile.acr index 1aa532e28..0c61e5c11 100644 --- a/Dockerfile.acr +++ b/Dockerfile.acr @@ -7,7 +7,7 @@ WORKDIR /tmp COPY . /tmp RUN npx npm-cli-adduser --username test --password test -e test@nocobase.com -r $VERDACCIO_URL RUN cd /tmp && \ - NEWVERSION="$(cat lerna.json | jq '.version' | tr -d '"').$(date +%s)" \ + NEWVERSION="$(cat lerna.json | jq '.version' | tr -d '"').$(date +'+%Y%m%d%H%M%S')" \ && tmp=$(mktemp) \ && jq ".version = \"${NEWVERSION}\"" lerna.json > "$tmp" && mv "$tmp" lerna.json RUN yarn install && yarn nocobase install && yarn pm add graph-collection-manager && yarn build diff --git a/docker/app-mysql/docker-compose.yml b/docker/app-mysql/docker-compose.yml index a8d64d622..a86a4dae1 100644 --- a/docker/app-mysql/docker-compose.yml +++ b/docker/app-mysql/docker-compose.yml @@ -4,7 +4,7 @@ networks: driver: bridge services: app: - image: nocobase/nocobase:0.8.0-alpha.13 + image: nocobase/nocobase:main networks: - nocobase depends_on: diff --git a/docker/app-postgres/docker-compose.yml b/docker/app-postgres/docker-compose.yml index d3c12c903..d4e11b96b 100644 --- a/docker/app-postgres/docker-compose.yml +++ b/docker/app-postgres/docker-compose.yml @@ -1,7 +1,7 @@ version: "3" services: app: - image: nocobase/nocobase:0.8.0-alpha.13 + image: nocobase/nocobase:main networks: - nocobase environment: diff --git a/docker/app-sqlite/docker-compose.yml b/docker/app-sqlite/docker-compose.yml index 11d587773..9cb13179c 100644 --- a/docker/app-sqlite/docker-compose.yml +++ b/docker/app-sqlite/docker-compose.yml @@ -4,7 +4,7 @@ networks: driver: bridge services: app: - image: nocobase/nocobase:0.8.0-alpha.13 + image: nocobase/nocobase:main networks: - nocobase environment: diff --git a/docs/en-US/welcome/getting-started/installation/docker-compose.md b/docs/en-US/welcome/getting-started/installation/docker-compose.md index f174d7637..5b788504f 100644 --- a/docs/en-US/welcome/getting-started/installation/docker-compose.md +++ b/docs/en-US/welcome/getting-started/installation/docker-compose.md @@ -92,7 +92,7 @@ NocoBase version ([click here for the latest version](https://hub.docker.com/r/n ```yml services: app: - image: nocobase/nocobase:0.7.0-alpha.78 + image: nocobase/nocobase:main ``` Environment variables @@ -100,14 +100,14 @@ Environment variables ```yml services: app: - image: nocobase/nocobase:0.7.0-alpha.78 + image: nocobase/nocobase:main environment: - DB_DIALECT=postgres - DB_HOST=postgres - DB_DATABASE=nocobase - DB_USER=nocobase - DB_PASSWORD=nocobase - - LOCAL_STORAGE_BASE_URL=http://localhost:13000/storage/uploads + - LOCAL_STORAGE_BASE_URL=/storage/uploads ``` - `DB_*` is the database related, if it is not the default database service of the example, please change it according to the actual situation. @@ -118,6 +118,8 @@ services: It may take a few minutes ```bash +# pull service images +$ docker-compose pull # run in the background $ docker-compose up -d # view app logs diff --git a/docs/en-US/welcome/getting-started/upgrading/docker-compose.md b/docs/en-US/welcome/getting-started/upgrading/docker-compose.md index 5e41bbc2d..c10ce4494 100644 --- a/docs/en-US/welcome/getting-started/upgrading/docker-compose.md +++ b/docs/en-US/welcome/getting-started/upgrading/docker-compose.md @@ -26,35 +26,13 @@ cd nocobase/docker/app-postgres ```yml services: app: - image: nocobase/nocobase:0.8.0-alpha.1 + image: nocobase/nocobase:main ``` -## 3. Delete old images (not required) - -If you are using the latest image, you need to stop and delete the corresponding container first. - -```bash -# find container ID -docker ps -# stop container -docker stop -# delete container -docker rm -``` - -Delete the old image - -```bash -# find image -docker images -# delete image -docker rmi -``` - -## 4. Restart the container +## 3. Restart the container ```bash +docker-compose pull docker-compose up -d app -# 查看 app 进程的情况 docker-compose logs app ``` diff --git a/docs/zh-CN/welcome/getting-started/installation/docker-compose.md b/docs/zh-CN/welcome/getting-started/installation/docker-compose.md index 71aad67fd..1e4700c49 100644 --- a/docs/zh-CN/welcome/getting-started/installation/docker-compose.md +++ b/docs/zh-CN/welcome/getting-started/installation/docker-compose.md @@ -92,7 +92,7 @@ NocoBase 版本([点此查看最新版本](https://hub.docker.com/r/nocobase/n ```yml services: app: - image: nocobase/nocobase:0.7.0-alpha.78 + image: nocobase/nocobase:main ``` 环境变量 @@ -100,14 +100,14 @@ services: ```yml services: app: - image: nocobase/nocobase:0.7.0-alpha.78 + image: nocobase/nocobase:main environment: - DB_DIALECT=postgres - DB_HOST=postgres - DB_DATABASE=nocobase - DB_USER=nocobase - DB_PASSWORD=nocobase - - LOCAL_STORAGE_BASE_URL=http://localhost:13000/storage/uploads + - LOCAL_STORAGE_BASE_URL=/storage/uploads ``` - `DB_*` 为数据库相关,如果不是例子默认的数据库服务,请根据实际情况修改; @@ -118,6 +118,8 @@ services: 安装过程可能需要等待几分钟 ```bash +# 拉取最新镜像 +$ docker-compose pull # 在后台运行 $ docker-compose up -d # 查看 app 进程的情况 diff --git a/docs/zh-CN/welcome/getting-started/upgrading/docker-compose.md b/docs/zh-CN/welcome/getting-started/upgrading/docker-compose.md index 8140020af..473759cb7 100644 --- a/docs/zh-CN/welcome/getting-started/upgrading/docker-compose.md +++ b/docs/zh-CN/welcome/getting-started/upgrading/docker-compose.md @@ -26,34 +26,15 @@ cd nocobase/docker/app-postgres ```yml services: app: - image: nocobase/nocobase:0.8.0-alpha.1 + image: nocobase/nocobase:main # main 分支 ``` -## 3. 删除旧镜像(非必须) - -如果使用的是 latest 镜像,需要先停止并删除相对应容器 - -```bash -# find container ID -docker ps -# stop container -docker stop -# delete container -docker rm -``` - -删除掉旧镜像 - -```bash -# find image -docker images -# delete image -docker rmi -``` - -## 4. 重启容器 +## 3. 重启容器 ```bash +# 拉取最新镜像 +docker-compose pull +# 启动 docker-compose up -d app # 查看 app 进程的情况 docker-compose logs app