Skip to main content

🗄️ Custom S3 Object Storage Bucket Configuration Guide

This document describes how to configure and use a custom S3 object storage service in the WeDa private deployment version.

Important Notice
  • Minio object storage started with Docker does not have high availability and is not recommended for storing files in production environments. The platform strongly recommends connecting to users' own external object storage services.

📦 1. S3 Object Storage Configuration​

This guide uses Tencent Cloud Object Storage COS as an example for configuration demonstration. Object storage services from other cloud providers, as long as they support the standard S3 interface protocol, are also supported. Specific configurations should be adjusted according to actual circumstances.

Deployment Requirements

WeDa needs to be deployed on Tencent Cloud CVM.

Custom Naming

Bucket name can be defined according to actual requirements.

🪣 1.1. Create lowcode-static bucket​

Creating lowcode-static bucket

Configuration Steps:

  1. Create a bucket

    • Click "Next" to complete bucket creation.

  2. Configure Permission Policy

    • Navigation: Bucket List > Select bucket > Permission Management > Policy > Add Permission

  3. Add Policy Configuration

    Add Permission Policy

    TCS Platform Special Configuration

    For the CSP Object Storage Service on the TCS platform, configure the policy as shown in the following diagram:

    TCS Platform Policy Configuration

  4. Complete Configuration

    • Click "Complete" to save the configuration

🪣 1.2. Create lowcode-storage bucket​

Creating lowcode-storage bucket

Configure permission policy: Click Bucket List -> Select bucket -> Permission Management -> Policy -> Add Permission.

  • Add policy

🪣 1.3. Create lowcode-ci bucket​

Permission Note

This bucket does not require a read-only policy

Creating lowcode-ci bucket

💻 2. Standalone Edition Configuration and Installation​

🖥️ 2.1. Visual Deployment Method​

Function Description

Standalone edition supports configuring external S3 middleware through a visual interface

Operation Steps:

  1. Access the installer page in your browser: http://<server IP>:38080
  2. Enable external S3 middleware configuration in the settings page

Visual Configuration Interface

📝 2.2. Script Deployment Method​

Add the following S3 configuration to the config.yaml file:

customS3:
  enabled: true
  endpoint: cos.ap-guangzhou.myqcloud.com
  port: 443
  scheme: https
  accessKey: "" # Enter your AccessKey
  secretKey: "" # Enter your SecretKey

  # Bucket Configuration (must match the name of the bucket created earlier)
  defaultBucket: lowcode-static-{appid} # Corresponds to the bucket created in step 1.1
  cloudStorageBucket: lowcode-storage-{appid} # Corresponds to the bucket created in step 1.2
  ciSourceBucket: lowcode-ci-{appid} # Corresponds to the bucket created in step 1.3

  pathStyle: false
  region: ap-guangzhou # Adjust according to the actual region
Configuration Precautions
  • Ensure that accessKey and secretKey have read and write permissions for the corresponding bucket
  • The bucket name must exactly match the name of the bucket created earlier
  • The region must match the region where the bucket is located :::

🚀 2.3. Installation and Deployment​

After configuration is complete, refer to Private Deployment Process for deployment.

🏗️ 3. Cluster Edition Configuration and Installation​

⚙️ 3.1. Add Configuration Information​

Edit the config.yaml file in the cluster installation directory:

If there is no config.yaml file, first run the command ./wedaCli init to generate it :::

s3:
  endpoint: cos.ap-guangzhou.myqcloud.com
  port: 443
  scheme: https
  accessKey: # Enter your AccessKey
  secretKey: # Enter your SecretKey
  insecureSkipVerify: true

  # Bucket Configuration (must match the name of the bucket created earlier)
  defaultBucket: lowcode-static-{appid} # Corresponds to the bucket created in step 1.1
  cloudStorageBucket: lowcode-storage-{appid} # Corresponds to the bucket created in step 1.2
  ciSource: lowcode-ci-{appid} # Corresponds to the bucket created in step 1.3

  region: ap-guangzhou # Adjust according to the actual region
  pathStyle: false
Cluster Edition Configuration Precautions
  • Ensure all cluster nodes can access the configured S3 storage service
  • Verify network connectivity and access permissions
  • The bucket name must exactly match the name of the bucket created earlier :::

🚀 3.2. Installation and Deployment​

After completing the configuration, run the following command to deploy:

# Start Cluster Deployment
./wedaCli up

📋 Configuration Checklist​

After completing the configuration, please confirm the following items:

  • ✅ Three required buckets (static, storage, ci) have been created
  • ✅ The lowcode-static bucket has been configured with the correct permission policy
  • ✅ AccessKey and SecretKey have sufficient permissions
  • ✅ Network connectivity is normal (firewall and security group configurations)
  • ✅ Region configuration is consistent with the actual region of the bucket
  • ✅ The bucket name is correctly filled in the configuration file

🔧 Troubleshooting​

If you encounter configuration issues, please check:

  1. Permission Issue: Confirm that the AccessKey has read and write permissions for the bucket
  2. Network Issue: Check the network connectivity from the server to the S3 service
  3. Configuration Issue: Verify the accuracy of the bucket name, region, and other configuration information
  4. Log Viewing: Troubleshoot specific error messages through system logs