NodeBB COS Uploads Plugin

This repo is a fork of nodebb-plugin-s3-uploads-updated and make a bit change to compatible with the COS api

npm install nodebb-plugin-cos-uploads

A plugin for NodeBB to take file uploads and store them on Tencent COS, uses the filter:uploadImage hook in NodeBB.

COS Uploads Configuration

You can configure this plugin via a combination of the below, for instance, you can use instance meta-data and environment variables in combination. You can also configure via the NodeBB Admin panel, which will result in the Bucket and Credentials being stored in the NodeBB Database.

If you decide to use the Database storage for Credentials, then they will take precedence over both Environment Variables and Instance Meta-data, the full load order is:

1. Database
2. Environment Variables
3. Instance Meta-data

Environment Variables

export COS_SECERT_ID="xxxxx"
export COS_SECRET_KEY="yyyyy"
export COS_UPLOADS_BUCKET="bucket"
export COS_REGION="region"
export COS_UPLOADS_HOST="host"
export COS_UPLOADS_PATH="path"

NOTE: Asset host is optional - If you do not specify an asset host, then the default asset host is <bucket>.cos.<region>.mqcloud.com.
NOTE: Asset path is optional - If you do not specify an asset path, then the default asset path is /.

~~Instance Meta-data~~

NOTE: You'll need to pass in the Bucket as either an Environment Variable or as a Database Backed Variable.

Database Backed Variables

From the NodeBB Admin panel, you can configure the following settings to be stored in the Database:

• bucket - The COS bucket to upload into
• host - The base URL for the asset. Typcially http://<bucke>.cos.<region>.qcloud.com
• path - The asset path (optional)
• region - The COS region
• secretId -The COS secretId
• secretKey - The COS secretKey

NOTE: Storing your COS Credentials in the database is bad practice, and you really shouldn't do it.

We highly recommend using either Environment Variables or Instance Meta-data instead.

Caveats

• Currently all uploads are stored in COS keyed by a UUID and file extension, as such, if a user uploads multiple avatars, all versions will still exist in COS. This is a known issue and may require some sort of cron job to scan for old uploads that are no longer referenced in order for those objects to be deleted from COS.

Contributing

Before contributing please check the contribution guidelines