Skip to content

Commit c8ddcfe

Browse files
committed
docs: update deployment guide with local storage details and improved formatting
1 parent 114036e commit c8ddcfe

File tree

3 files changed

+27
-19
lines changed

3 files changed

+27
-19
lines changed

docs/en/claw-cloud-run.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This guide will help you deploy the `aistudio-to-api` service on [Claw Cloud Run](https://claw.cloud/).
44

5-
## Deployment Steps
5+
## 📦 Deployment Steps
66

77
1. **Login**: Go to [https://us-west-1.run.claw.cloud/](https://us-west-1.run.claw.cloud/) and log in to your account.
88
2. **Create App**: Navigate to **App Launchpad** and click the **Create App** button in the top right corner.
@@ -19,6 +19,10 @@ This guide will help you deploy the `aistudio-to-api` service on [Claw Cloud Run
1919
- **Container Port**: `7860`
2020
- **Public Access**: Toggle **On** (Leave the URL usage as is).
2121

22+
**Local Storage**:
23+
- **Capacity**:1
24+
- **Mount Path**:/app/configs/auth
25+
2226
**Environment Variables**:
2327

2428
You must set the `API_KEYS` variable. Other variables are optional (refer to the [Configuration](../../README.md#-configuration) section in the main README).
@@ -29,7 +33,7 @@ This guide will help you deploy the `aistudio-to-api` service on [Claw Cloud Run
2933

3034
4. **Deploy**: Click **Create App** to start the deployment.
3135

32-
## Accessing the Service
36+
## 📡 Accessing the Service
3337

3438
1. Once the app is running, go to the **Network** tab in the App details page.
3539
2. Copy the **Public Address** (URL).

docs/zh/claw-cloud-run.md

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,35 +2,39 @@
22

33
本指南将帮助你在 [Claw Cloud Run](https://claw.cloud/) 上部署 `aistudio-to-api` 服务。
44

5-
## 部署步骤
5+
## 📦 部署步骤
66

7-
1. **登录**: 前往 [https://us-west-1.run.claw.cloud/](https://us-west-1.run.claw.cloud/) 并登录你的账号。
8-
2. **创建应用**: 进入 **App Launchpad**,点击右上角的 **Create App** 按钮。
9-
3. **配置应用**: 填写以下参数:
10-
- **Application Name**: 填写一个你喜欢的英文名称 (例如 `aistudio-api`)
11-
- **Image**: 选择 **Public**
12-
- **Image Name**: `ghcr.io/ibenzene/aistudio-to-api:latest`
7+
1. **登录**前往 [https://us-west-1.run.claw.cloud/](https://us-west-1.run.claw.cloud/) 并登录你的账号。
8+
2. **创建应用**进入 **App Launchpad**,点击右上角的 **Create App** 按钮。
9+
3. **配置应用**填写以下参数:
10+
- **Application Name**填写一个你喜欢的英文名称例如 `aistudio-api`
11+
- **Image**选择 **Public**
12+
- **Image Name**`ghcr.io/ibenzene/aistudio-to-api:latest`
1313

1414
**Usage**:
15-
- **CPU**: `0.5`
16-
- **Memory**: `1G`
15+
- **CPU**`0.5`
16+
- **Memory**`1G`
1717

1818
**Network**:
19-
- **Container Port**: `7860`
20-
- **Public Access**: 开启 (Toggle **On**,后面的网址选项不用动)
19+
- **Container Port**`7860`
20+
- **Public Access**:开启(Toggle **On**,后面的网址选项不用动
2121

22-
**环境变量 (Environment Variables)**:
22+
**Local Storage**:
23+
- **Capacity**:1
24+
- **Mount Path**:/app/configs/auth
2325

24-
必填参数 `API_KEYS`。其他参数选填 (参考主 README 中的 [配置](../../README_CN.md#-相关配置) 部分)。
26+
**环境变量(Environment Variables)**:
27+
28+
必填参数 `API_KEYS`。其他参数选填(参考主 README 中的 [配置](../../README_CN.md#-相关配置) 部分)。
2529

2630
| Name | Value | Description |
2731
| :--------- | :-------------------- | :------------------------------------------------- |
2832
| `API_KEYS` | `your-secret-key-123` | **必填**。自定义你的访问密钥,多个密钥用逗号分隔。 |
2933

30-
4. **部署**: 点击 **Create App** 开始部署。
34+
4. **部署**点击 **Create App** 开始部署。
3135

32-
## 访问服务
36+
## 📡 访问服务
3337

3438
1. 等待应用运行起来后,在应用详情页点击 **Network** 标签页。
35-
2. 复制 **Public Address** (公网地址)
39+
2. 复制 **Public Address**公网地址
3640
3. 在浏览器中访问该地址。输入你设置的 `API_KEYS` 即可进入管理页面。

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "aistudio-to-api",
3-
"version": "0.2.3",
3+
"version": "0.2.4",
44
"author": "Ellinav",
55
"description": "Encapsulate Gemini models on AI Studio as API services.",
66
"main": "main.js",

0 commit comments

Comments
 (0)