Skip to content

Commit bf718f3

Browse files
committed
docs(instance): 更新实例配置字段描述
调整了 `instance.md` 中表格字段的描述内容,使其更加清晰准确。 主要更新包括对 `basePort` 字段的描述优化,以及其他字段说明的微调以提升可读性。
1 parent d9cb4fb commit bf718f3

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

en/models/instance.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -66,34 +66,34 @@ Server ping configuration (deprecated).
6666

6767
Instance configuration information.
6868

69-
| Field Name | Type | Description |
70-
| ------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
71-
| `nickname` | str | Instance name |
72-
| `startCommand` | str | Start command |
73-
| `stopCommand` | str | Stop command |
74-
| `cwd` | str | Working directory |
75-
| `ie` | str | Input encoding |
76-
| `oe` | str | Output encoding |
77-
| `createDatetime` | int | Creation time (Unix timestamp) |
78-
| `lastDatetime` | int | Last modification time (Unix timestamp) |
79-
| `type` | str | Instance type (e.g., universal, minecraft) |
80-
| `tag` | list[str] | Instance tags |
81-
| `endTime` | int \| None | Instance expiration time |
82-
| `fileCode` | str | File encoding |
83-
| `processType` | str | Process type (e.g., docker, general) |
84-
| `updateCommand` | str | Update command |
85-
| `actionCommandList` | list[str] | List of executable commands for the instance |
86-
| `crlf` | CRLFType | Line break type |
87-
| `docker` | DockerConfig | Docker-related configuration |
88-
| `enableRcon` | bool | Enable RCON remote control |
89-
| `rconPassword` | str | RCON connection password |
90-
| `rconPort` | int | RCON port |
91-
| `rconIp` | str | RCON IP address |
92-
| `terminalOption` | TerminalOption | Terminal option configuration |
93-
| `eventTask` | EventTask | Event task configuration |
94-
| `pingConfig` | PingConfig | Server ping monitoring configuration (deprecated) |
95-
| `runAs` | str | System user to run the instance, empty to use the panel's system user |
96-
| `basePort` | int | The allocated starting port. This number corresponds to a specific variable, and each newly added instance will be assigned incrementally. |
69+
| Field Name | Type | Description |
70+
| ------------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
71+
| `nickname` | str | Instance name |
72+
| `startCommand` | str | Start command |
73+
| `stopCommand` | str | Stop command |
74+
| `cwd` | str | Working directory |
75+
| `ie` | str | Input encoding |
76+
| `oe` | str | Output encoding |
77+
| `createDatetime` | int | Creation time (Unix timestamp) |
78+
| `lastDatetime` | int | Last modification time (Unix timestamp) |
79+
| `type` | str | Instance type (e.g., universal, minecraft) |
80+
| `tag` | list[str] | Instance tags |
81+
| `endTime` | int \| None | Instance expiration time |
82+
| `fileCode` | str | File encoding |
83+
| `processType` | str | Process type (e.g., docker, general) |
84+
| `updateCommand` | str | Update command |
85+
| `actionCommandList` | list[str] | List of executable commands for the instance |
86+
| `crlf` | CRLFType | Line break type |
87+
| `docker` | DockerConfig | Docker-related configuration |
88+
| `enableRcon` | bool | Enable RCON remote control |
89+
| `rconPassword` | str | RCON connection password |
90+
| `rconPort` | int | RCON port |
91+
| `rconIp` | str | RCON IP address |
92+
| `terminalOption` | TerminalOption | Terminal option configuration |
93+
| `eventTask` | EventTask | Event task configuration |
94+
| `pingConfig` | PingConfig | Server ping monitoring configuration (deprecated) |
95+
| `runAs` | str | System user to run the instance, empty to use the panel's system user |
96+
| `basePort` | int | The allocated starting port; this number corresponds to the variable from to , and each new instance will be incrementally assigned. |
9797

9898
## _class_ `InstanceDetail(BaseModel)`
9999

0 commit comments

Comments
 (0)