From 502107686477ffa2cd54e12039f800812be68c6f Mon Sep 17 00:00:00 2001 From: Dayuan Jiang <34411969+DayuanJiang@users.noreply.github.com> Date: Wed, 3 Dec 2025 21:15:25 +0900 Subject: [PATCH] fix: use static sha- prefix for Docker tags and add Docker run instructions to README (#62) --- .github/workflows/docker-build.yml | 2 +- README.md | 20 ++++++++++++++++++++ README_CN.md | 20 ++++++++++++++++++++ README_JA.md | 20 ++++++++++++++++++++ 4 files changed, 61 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docker-build.yml b/.github/workflows/docker-build.yml index 5cb7e84..d372242 100644 --- a/.github/workflows/docker-build.yml +++ b/.github/workflows/docker-build.yml @@ -50,7 +50,7 @@ jobs: type=semver,pattern={{version}} type=semver,pattern={{major}}.{{minor}} type=semver,pattern={{major}} - type=sha,prefix={{branch}}- + type=sha,prefix=sha- type=raw,value=latest,enable={{is_default_branch}} - name: Build and push Docker image diff --git a/README.md b/README.md index 2204ffa..2015277 100644 --- a/README.md +++ b/README.md @@ -93,6 +93,26 @@ Note that `claude-sonnet-4-5` has trained on draw.io diagrams with AWS logos, so ## Getting Started +### Run with Docker (Recommended) + +If you just want to run it locally, the best way is to use Docker. + +First, install Docker if you haven't already: [Get Docker](https://docs.docker.com/get-docker/) + +Then run: + +```bash +docker run -d -p 3000:3000 \ + -e AI_PROVIDER=openai \ + -e AI_MODEL=gpt-4o \ + -e OPENAI_API_KEY=your_api_key \ + ghcr.io/dayuanjiang/next-ai-draw-io:latest +``` + +Open [http://localhost:3000](http://localhost:3000) in your browser. + +Replace the environment variables with your preferred AI provider configuration. See [Multi-Provider Support](#multi-provider-support) for available options. + ### Installation 1. Clone the repository: diff --git a/README_CN.md b/README_CN.md index 2718e23..fa96a28 100644 --- a/README_CN.md +++ b/README_CN.md @@ -93,6 +93,26 @@ https://github.com/user-attachments/assets/b2eef5f3-b335-4e71-a755-dc2e80931979 ## 快速开始 +### 使用Docker运行(推荐) + +如果您只想在本地运行,最好的方式是使用Docker。 + +首先,如果您还没有安装Docker,请先安装:[获取Docker](https://docs.docker.com/get-docker/) + +然后运行: + +```bash +docker run -d -p 3000:3000 \ + -e AI_PROVIDER=openai \ + -e AI_MODEL=gpt-4o \ + -e OPENAI_API_KEY=your_api_key \ + ghcr.io/dayuanjiang/next-ai-draw-io:latest +``` + +在浏览器中打开 [http://localhost:3000](http://localhost:3000)。 + +请根据您首选的AI提供商配置替换环境变量。可用选项请参阅[多提供商支持](#多提供商支持)。 + ### 安装 1. 克隆仓库: diff --git a/README_JA.md b/README_JA.md index aa86546..a61195d 100644 --- a/README_JA.md +++ b/README_JA.md @@ -93,6 +93,26 @@ https://github.com/user-attachments/assets/b2eef5f3-b335-4e71-a755-dc2e80931979 ## はじめに +### Dockerで実行(推奨) + +ローカルで実行したいだけなら、Dockerを使用するのが最も簡単です。 + +まず、Dockerをインストールしていない場合はインストールしてください:[Dockerを入手](https://docs.docker.com/get-docker/) + +次に実行: + +```bash +docker run -d -p 3000:3000 \ + -e AI_PROVIDER=openai \ + -e AI_MODEL=gpt-4o \ + -e OPENAI_API_KEY=your_api_key \ + ghcr.io/dayuanjiang/next-ai-draw-io:latest +``` + +ブラウザで [http://localhost:3000](http://localhost:3000) を開いてください。 + +環境変数はお好みのAIプロバイダー設定に置き換えてください。利用可能なオプションについては[マルチプロバイダーサポート](#マルチプロバイダーサポート)を参照してください。 + ### インストール 1. リポジトリをクローン: