docs: env variable

Author: Zeyi-Lin

.vitepress/en.ts

@@ -237,7 +237,7 @@ function sidebarAPI(): DefaultTheme.SidebarItem[] {
       { text: 'swanlab login', link: 'cli-swanlab-login' },
       { text: 'swanlab logout', link: 'cli-swanlab-logout' },
       { text: 'swanlab convert', link: 'cli-swanlab-convert' },
-      { text: '(Beta) swanlab remote gpu', link: 'cli-swanlab-remote-gpu' },
+      // { text: '(Beta) swanlab remote gpu', link: 'cli-swanlab-remote-gpu' },
       { text: 'Other', link: 'cli-swanlab-other' },
     ]
   },
@@ -256,5 +256,13 @@ function sidebarAPI(): DefaultTheme.SidebarItem[] {
       { text: 'integration', link: 'py-integration' },
       { text: 'converter', link: 'py-converter' },
     ]
-  },]
-}
+  },
+  {
+    text: 'Other',
+    // collapsed: false,
+    items: [
+      { text: 'Environment Variables', link: 'environment-variable' },
+    ]
+  }
+]
+}

.vitepress/zh.ts

@@ -237,7 +237,7 @@ function sidebarAPI(): DefaultTheme.SidebarItem[] {
       { text: 'swanlab login', link: 'cli-swanlab-login' },
       { text: 'swanlab logout', link: 'cli-swanlab-logout' },
       { text: 'swanlab convert', link: 'cli-swanlab-convert' },
-      { text: '(内测中) swanlab remote gpu', link: 'cli-swanlab-remote-gpu' },
+      // { text: '(内测中) swanlab remote gpu', link: 'cli-swanlab-remote-gpu' },
       { text: '其他', link: 'cli-swanlab-other' },
     ]
   },
@@ -256,5 +256,16 @@ function sidebarAPI(): DefaultTheme.SidebarItem[] {
       { text: 'integration', link: 'py-integration' },
       { text: 'converter', link: 'py-converter' },
     ]
-  },]
+  },
+  {
+    text: '其他',
+    // collapsed: false,
+    items: [
+      { text: '环境变量', link: 'environment-variable' },
+    ]
+  }
+
+
+
+]
 }

en/api/environment-variable.md

@@ -0,0 +1,49 @@
+# Environment Variables
+
+[⚙️Full Environment Variables -> Github](https://github.com/SwanHubX/SwanLab/blob/main/swanlab/env.py)
+
+## Global Configuration
+
+### `SWANLAB_FOLDER`
+- **Description**: The path where the SwanLab global folder is saved, defaulting to the `.swanlab` folder in the user's home directory.
+- **Environment Variable**: `SWANLAB_FOLDER`
+
+### `SWANLOG_FOLDER`
+- **Description**: The path where SwanLab parsed log files are saved, defaulting to the `swanlog` folder in the current running directory.
+- **Environment Variable**: `SWANLOG_FOLDER`
+
+### `SWANLAB_MODE`
+- **Description**: The parsing mode of SwanLab, involving callbacks registered by the operator. Currently, there are three modes: `local`, `cloud`, and `disabled`, with the default being `cloud`. **Note: Case sensitive**.
+- **Environment Variable**: `SWANLAB_MODE`
+
+## Service Configuration
+
+### `SWANBOARD_PROT`
+- **Description**: The port for the CLI offline dashboard `swanboard` service.
+- **Environment Variable**: `SWANLAB_BOARD_PORT`
+
+### `SWANBOARD_HOST`
+- **Description**: The address for the CLI offline dashboard `swanboard` service.
+- **Environment Variable**: `SWANLAB_BOARD_HOST`
+
+### `SWANLAB_WEB_HOST`
+- **Description**: The web address for the SwanLab cloud environment.
+- **Environment Variable**: `SWANLAB_WEB_HOST`
+
+### `API_HOST`
+- **Description**: The API address for the SwanLab cloud environment.
+- **Environment Variable**: `SWANLAB_API_HOST`
+
+## Login Authentication
+
+### `SWANLAB_API_KEY`
+- **Description**: The cloud API Key. During login, this environment variable is checked first. If it does not exist, it checks whether the user is already logged in. If not logged in, the login process is initiated.
+  - If a string is passed to the `login` interface, this environment variable is invalid.
+  - If the user is already logged in, this environment variable takes precedence over locally stored login information.
+- **Environment Variable**: `SWANLAB_API_KEY`
+
+## Others
+
+### `SWANLAB_WEBHOOK`
+- **Description**: Webhook address. If this environment variable exists, SwanLab will call this address to send a message upon successful initialization.
+- **Environment Variable**: `SWANLAB_WEBHOOK`

zh/api/environment-variable.md

@@ -0,0 +1,49 @@
+# 环境变量
+
+[⚙️完整环境变量 -> Github](https://github.com/SwanHubX/SwanLab/blob/main/swanlab/env.py)
+
+## 全局配置
+
+### `SWANLAB_FOLDER`
+- **描述**: SwanLab 全局文件夹保存的路径，默认为用户主目录下的 `.swanlab` 文件夹。
+- **环境变量**: `SWANLAB_FOLDER`
+
+### `SWANLOG_FOLDER`
+- **描述**: SwanLab 解析日志文件保存的路径，默认为当前运行目录的 `swanlog` 文件夹。
+- **环境变量**: `SWANLOG_FOLDER`
+
+### `SWANLAB_MODE`
+- **描述**: SwanLab 的解析模式，涉及操作员注册的回调。目前有三种模式：`local`、`cloud`、`disabled`，默认为 `cloud`。**注意：大小写敏感**。
+- **环境变量**: `SWANLAB_MODE`
+
+## 服务配置
+
+### `SWANBOARD_PROT`
+- **描述**: CLI 离线看板 `swanboard` 服务的端口。
+- **环境变量**: `SWANLAB_BOARD_PORT`
+
+### `SWANBOARD_HOST`
+- **描述**: CLI 离线看板 `swanboard` 服务的地址。
+- **环境变量**: `SWANLAB_BOARD_HOST`
+
+### `SWANLAB_WEB_HOST`
+- **描述**: SwanLab 云端环境的 Web 地址。
+- **环境变量**: `SWANLAB_WEB_HOST`
+
+### `API_HOST`
+- **描述**: SwanLab 云端环境的 API 地址。
+- **环境变量**: `SWANLAB_API_HOST`
+
+## 登录认证
+
+### `SWANLAB_API_KEY`
+- **描述**: 云端 API Key。登录时会首先查找此环境变量，如果不存在，判断用户是否已登录，未登录则进入登录流程。
+  - 如果 `login` 接口传入字符串，此环境变量无效。
+  - 如果用户已登录，此环境变量的优先级高于本地存储的登录信息。
+- **环境变量**: `SWANLAB_API_KEY`
+
+## 其他
+
+### `SWANLAB_WEBHOOK`
+- **描述**: Webhook 地址。SwanLab 初始化完毕时，如果此环境变量存在，会调用此地址发送消息。
+- **环境变量**: `SWANLAB_WEBHOOK`