From 37a130993aaa3ef835099d35534d96ca0745c761 Mon Sep 17 00:00:00 2001 From: fujie Date: Mon, 9 Mar 2026 22:01:25 +0800 Subject: [PATCH] docs: improve baseURL configuration guidance in batch installation guides - Add baseURL configuration examples in release-prep.agent.md (localhost, IP, domain) - Update release-workflow.md with baseURL configuration options - Update release-workflow.zh.md with baseURL configuration options - Improve .env.example documentation with URL examples and better instructions - Support various OpenWebUI instance locations: localhost, remote IP, or domain --- .github/agents/release-prep.agent.md | 7 ++++++- docs/release-workflow.md | 9 +++++++-- docs/release-workflow.zh.md | 9 +++++++-- scripts/.env.example | 8 +++++++- 4 files changed, 27 insertions(+), 6 deletions(-) diff --git a/.github/agents/release-prep.agent.md b/.github/agents/release-prep.agent.md index 7602119..b788056 100644 --- a/.github/agents/release-prep.agent.md +++ b/.github/agents/release-prep.agent.md @@ -87,8 +87,13 @@ After release is published, users can quickly install all plugins: git clone https://github.com/Fu-Jie/openwebui-extensions.git cd openwebui-extensions -# Setup API key +# Setup API key and instance URL echo "api_key=sk-your-api-key-here" > scripts/.env +echo "url=http://localhost:3000" >> scripts/.env + +# If using remote instance, configure the baseURL: +# echo "url=http://192.168.1.10:3000" >> scripts/.env +# echo "url=https://openwebui.example.com" >> scripts/.env # Install all plugins at once python scripts/install_all_plugins.py diff --git a/docs/release-workflow.md b/docs/release-workflow.md index 434f24a..4c51a16 100644 --- a/docs/release-workflow.md +++ b/docs/release-workflow.md @@ -189,15 +189,20 @@ python scripts/extract_plugin_versions.py --json --output versions.json ## Installing All Plugins to Your Instance -After a release, you can quickly install all plugins to your local OpenWebUI instance: +After a release, you can quickly install all plugins to your OpenWebUI instance: ```bash # Clone the repository git clone https://github.com/Fu-Jie/openwebui-extensions.git cd openwebui-extensions -# Create .env file with your API key +# Configure API key and instance URL echo "api_key=sk-your-api-key-here" > scripts/.env +echo "url=http://localhost:3000" >> scripts/.env + +# For remote instances, set the appropriate baseURL: +# echo "url=http://192.168.1.10:3000" >> scripts/.env +# echo "url=https://openwebui.example.com" >> scripts/.env # Install all plugins at once python scripts/install_all_plugins.py diff --git a/docs/release-workflow.zh.md b/docs/release-workflow.zh.md index f432cb2..f1db1f8 100644 --- a/docs/release-workflow.zh.md +++ b/docs/release-workflow.zh.md @@ -187,15 +187,20 @@ python scripts/extract_plugin_versions.py --json --output versions.json ## 批量安装所有插件到你的实例 -在发布之后，你可以快速将所有插件安装到本地 OpenWebUI 实例： +在发布之后，你可以快速将所有插件安装到 OpenWebUI 实例： ```bash # 克隆仓库 git clone https://github.com/Fu-Jie/openwebui-extensions.git cd openwebui-extensions -# 创建 .env 文件并配置 API 密钥 +# 配置 API 密钥和实例地址 echo "api_key=sk-your-api-key-here" > scripts/.env +echo "url=http://localhost:3000" >> scripts/.env + +# 如果是远程实例，需要设置相应的 baseURL： +# echo "url=http://192.168.1.10:3000" >> scripts/.env +# echo "url=https://openwebui.example.com" >> scripts/.env # 一次性安装所有插件 python scripts/install_all_plugins.py diff --git a/scripts/.env.example b/scripts/.env.example index 5087534..fc4a48e 100644 --- a/scripts/.env.example +++ b/scripts/.env.example @@ -2,7 +2,12 @@ # # Instructions: # - api_key: Copy from OpenWebUI Settings (starts with sk-) -# - url: OpenWebUI server address +# - url: OpenWebUI server address (supports localhost, IP, and domain) +# +# URL Examples: +# - Local: http://localhost:3000 +# - Remote IP: http://192.168.1.10:3000 +# - Domain: https://openwebui.example.com # # Environment variable precedence (highest to lowest): # 1. OPENWEBUI_API_KEY / OPENWEBUI_URL environment variables @@ -13,6 +18,7 @@ api_key=sk-your-api-key-here # OpenWebUI server address (required) +# Configure the baseURL where your OpenWebUI instance is running url=http://localhost:3000 # Alternatively, use environment variable format (both methods are equivalent)