Skip to content

Commit

Permalink
docs: update external storage document
Browse files Browse the repository at this point in the history
  • Loading branch information
moonrailgun committed May 8, 2024
1 parent 125df13 commit 8fbc090
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
11 changes: 10 additions & 1 deletion website/docs/advanced-usage/external-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,25 @@ As the usage scale progresses, the user's storage cost for the Tailchat file sys
## Config

You need to configure the environment variables as follows:
- `MINIO_URL`: s3 service address
- `MINIO_URL`: s3 service address, `<hostname>:<port>`, for example: `example.com:443`, not need protocol part like `https://`
- `MINIO_SSL`: Whether the s3 service enables SSL verification is required for some providers. Default is `false`
- `MINIO_USER`: s3 service username
- `MINIO_PASS`: s3 service password
- `MINIO_BUCKET_NAME`: s3 service bucket name
- `MINIO_PATH_STYLE`: path mode, optional values: `VirtualHosted` or `Path`
- S3 protocol has two style, `VirtualHosted` use in `<bucketname>.example.com`, and `Path` use in `example.com/<bucketname>`
- `STATIC_URL`: The uploaded static path address, which is transferred by the server by default. If you want to directly connect to external storage, you need to change it to an externally accessible address

> For `aliyunoss`, we can refer to this document for content-related help: https://www.alibabacloud.com/help/en/oss/developer-reference/use-amazon-s3-sdks-to-access-oss
### Example

**R2**:
```bash
MINIO_URL=<account-id>.r2.cloudflarestorage.com:443
MINIO_PATH_STYLE=Path
```

## Data migration

If you are migrating from a privately deployed `minio` service to a public cloud, then you need to migrate the old data.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,25 @@ title: 外部存储
## 配置

你需要通过环境变量配置如下:
- `MINIO_URL`: s3服务地址
- `MINIO_URL`: s3 服务地址,`<hostname>:<port>`,例如:`example.com:443`,不需要协议部分如 `https://`
- `MINIO_SSL`: s3服务是否启用ssl验证,对于某些提供商是必须的。默认为`false`
- `MINIO_USER`: s3服务用户名
- `MINIO_PASS`: s3服务密码
- `MINIO_BUCKET_NAME`: s3服务 bucket 名
- `MINIO_PATH_STYLE`: 路径模式,可选值: `VirtualHosted``Path`
- S3 协议有两种风格,`VirtualHosted` 用于 `<bucketname>.example.com``Path` 用于 `example.com/<bucketname>`
- `STATIC_URL`: 上传后的静态路径地址,默认走服务器中转,如果想要走外部存储直连的话需要改为外部可访问的地址

> 对于 `aliyunoss` 我们可以参考该文档获得内容相关帮助: https://www.alibabacloud.com/help/en/oss/developer-reference/use-amazon-s3-sdks-to-access-oss
### 示例

**R2**:
```bash
MINIO_URL=<account-id>.r2.cloudflarestorage.com:443
MINIO_PATH_STYLE=Path
```

## 数据迁移

如果你是从私有化部署的 `minio` 服务迁移到公有云上,那么你需要对旧的数据进行迁移。
Expand Down

0 comments on commit 8fbc090

Please sign in to comment.