Merge pull request #29 from aspirantzhang/improve/doc

chore: improve doc
alphasnow · Aug 21, 2023 · d5eb8d0 · d5eb8d0
2 parents 1d3a0c7 + 7387913
commit d5eb8d0
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/README-CN.md b/README-CN.md
@@ -49,6 +49,7 @@
             "endpoint"          => env("OSS_ENDPOINT"),                // 必填, 对象存储的Endpoint, 示例: oss-cn-shanghai.aliyuncs.com
             "internal"          => env("OSS_INTERNAL", null),          // 选填, 内网上传地址,填写即启用 示例: oss-cn-shanghai-internal.aliyuncs.com
             "domain"            => env("OSS_DOMAIN", null),            // 选填, 绑定域名,填写即启用 示例: oss.my-domain.com
+            "is_cname"          => env("OSS_CNAME", false),            // 选填, 若Endpoint为自定义域名，此项要为true，见：https://github.com/aliyun/aliyun-oss-php-sdk/blob/572d0f8e099e8630ae7139ed3fdedb926c7a760f/src/OSS/OssClient.php#L113C1-L122C78
             "prefix"            => env("OSS_PREFIX", ""),              // 选填, 统一存储地址前缀
             "use_ssl"           => env("OSS_SSL", false),              // 选填, 是否使用HTTPS
             "reverse_proxy"     => env("OSS_REVERSE_PROXY", false),    // 选填, 域名是否使用NGINX代理绑定

diff --git a/README.md b/README.md
@@ -49,6 +49,7 @@ If client direct transmission is required, Use web server signature direct trans
             "endpoint"          => env("OSS_ENDPOINT"),                // Required, For example: oss-cn-shanghai.aliyuncs.com
             "internal"          => env("OSS_INTERNAL", null),          // Optional, For example: oss-cn-shanghai-internal.aliyuncs.com
             "domain"            => env("OSS_DOMAIN", null),            // Optional, For example: oss.my-domain.com
+            "is_cname"          => env("OSS_CNAME", false),            // Optional, if the Endpoint is a custom domain name, this must be true, see: https://github.com/aliyun/aliyun-oss-php-sdk/blob/572d0f8e099e8630ae7139ed3fdedb926c7a760f/src/OSS/OssClient.php#L113C1-L122C78
             "prefix"            => env("OSS_PREFIX", ""),              // Optional, The prefix of the store path
             "use_ssl"           => env("OSS_SSL", false),              // Optional, Whether to use HTTPS
             "reverse_proxy"     => env("OSS_REVERSE_PROXY", false),    // Optional, Whether to use the Reverse proxy, such as nginx