Skip to content

Commit

Permalink
docs: add tencent cloud COS
Browse files Browse the repository at this point in the history
  • Loading branch information
UsherFall committed Jul 23, 2023
1 parent 628ceb4 commit 8872ca8
Show file tree
Hide file tree
Showing 8 changed files with 61 additions and 1 deletion.
15 changes: 15 additions & 0 deletions docs/provider/storage/amazon-s3.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,25 @@ Edit the object ownership, check **ACLs enabled**.

### Config Casdoor

| Name | Name in amazon | is required |
|---------------------|-------------------|-------------|
| Client ID | Access key | required |
| Client secret | Secret access key | required |
| Endpoint | Endpoint | required |
| Endpoint (intranet) | VPC endpoint | |
| Bucket | Bucket name | required |
| Path prefix | | |
| Domain | CloudFront domain | |
| Region ID | AWS region | required |

Fill the necessary information, includes the `Client ID` and `Client Secret` obtained from the `access key` and `secret access key` in the previous step. You can refer to this documentation for information on the formatting of the `endpoint`: [Website endpoints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/WebsiteEndpoints.html)

![amazon s3 provider](/img/providers/storage/amazonProvider.png)

### (Optional) Use VPC

You can refer to the official documentation for configuration: [Access AWS services through AWS PrivateLink](https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-access-aws-services.html)

### (Optional) Use CloudFront distribution

Follow the document to config CloudFront: [config CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/GettingStarted.SimpleDistribution.html)
Expand Down
2 changes: 1 addition & 1 deletion docs/provider/storage/azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Select the Azure Blob as the storage type. ![azureSelect.png](/img/providers/sto

### Step2. Fill the necessary information in Casdoor

There are three required fields. `Client ID`, `Client secret`, `Bucket`. The relationship corresponding to the Azure Blob account is as follows:
There are four required fields. `Client ID`, `Client secret`, `Endpoint`, `Bucket`. The relationship corresponding to the Azure Blob account is as follows:

| Name | Name in Azure | is required |
|---------------------|-----------------|-------------|
Expand Down
44 changes: 44 additions & 0 deletions docs/provider/storage/tencentCloudCOS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: Tencent Cloud COS
description: Using Tencent Cloud COS as a storage provider for Casdoor
keywords: [Tencent Cloud COS, storage, provider]
authors: [UsherFall]
---

:::note

This is an example of **Tencent Cloud COS**.

:::

### Fill the necessary information in Casdoor

There are five required fields. `Client ID`, `Client secret`, `Endpoint`, `Bucket`, `Region ID`. The relationship corresponding to the Tencent Cloud COS account is as follows:

| Name | Name in Tencent | is required |
|---------------------|-----------------|-------------|
| Client ID | SecretId | required |
| Client secret | SecretKey | required |
| Endpoint | Endpoint | required |
| Bucket | BucketName | required |
| Path prefix | | |
| Domain | CDNDomain | |
| Region ID | Region | required |

#### Tencent Cloud cos information

- SecretId and SecretKey

![](/img/providers/storage/tencentKey.png)

- Endpoint, BucketName and Region

![](/img/providers/storage/tencentConfig.png)

- (Optional) CDNDomain

You can refer to the official documentation for configuration: [config CDN](https://cloud.tencent.com/document/product/436/18670#.E5.AF.B9.E8.87.AA.E5.AE.9A.E4.B9.89.E5.9F.9F.E5.90.8D.E9.85.8D.E7.BD.AE-cdn-.E5.8A.A0.E9.80.9F)

#### Config Casdoor provider

![](/img/providers/storage/tencentResult.png)
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,7 @@ module.exports = {
"provider/storage/azure",
"provider/storage/minio",
"provider/storage/aliyun-oss",
"provider/storage/tencentCloudCOS",
],
},
{
Expand Down
Binary file modified static/img/providers/storage/amazonProvider.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/providers/storage/tencentConfig.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/providers/storage/tencentKey.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/providers/storage/tencentResult.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8872ca8

Please sign in to comment.