Skip to content

Commit

Permalink
doc: 更新文档
Browse files Browse the repository at this point in the history
  • Loading branch information
DesnLee committed Sep 6, 2023
1 parent b27c7c8 commit 841af60
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,20 @@ ssm new
- `--port``-p` :指定端口映射,默认为 `3000`,且必须可用,如果您传递了 `-i` 标标志来创建一个前端容器,则默认端口为 `80`。如果你想使用域名访问服务,则需要使用反向代理工具(如 Nginx 或 Caddy)手动代理该端口。


### update

更新一个 Sub-Store Docker 容器,确保镜像已经存在且正在运行。

```bash
ssm update
```

该命令支持以下 `flag`

- `--name``-n` :一个正在运行的容器名称,默认名称为 `ssm-backend`

- `--version``-v` :一个 [Sub-Store Release](https://github.com/sub-store-org/Sub-Store/releases) 的版本字符串,默认获取最新版本。如果您更新目标为前端容器,则 `-v` 标志将被忽略,它总是使用最新版本的前端。


### start

Expand Down
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,21 @@ this command support the following flags:
- `--port` or `-p` : To successfully create a new Docker container, you need to specify the port mapping. The default port is `3000`, and it must be available. If you pass `-i` to create a front-end container, the default port will be `80`. If you want to access the container using a domain name, you will need to manually proxy this port with a reverse proxy tool such as Nginx or Caddy.


### update

To update a sub-store docker container, ensure that the image already exists and is running.

```bash
ssm update
```

this command support the following flags:

- `--name` or `-n` : A name of running container, default name is `ssm-backend`.

- `--version` or `-v` : A [Sub-Store release](https://github.com/sub-store-org/Sub-Store/releases) version string, default is latest. If you update a front-end container, `-v` will be ignored, it always uses the latest version of the front-end.


### start

Start a non-running sub-store Docker container by name, default name set as `ssm-backend`.
Expand Down

0 comments on commit 841af60

Please sign in to comment.