松鼠の文档

# External storage

External storage allows to use external servers for storing user uploads, which helps to leverage your server load and deliver a more reliable website. If you use multiple external storage servers, it will help to distribute the traffic of these assets.

# Supported APIs

# How it works

External storage works in two layers:

  • Backend: Uploads objects to the target server
  • Frontend: Access uploaded objects directly

# Storage URL

Chevereto maps each image to the corresponding storage server using the given Storage URL, which acts as a base URL to locate that file.

For example, using Amazon S3 with direct storage:

Property Value
Bucket my-bucket
Storage URL https://s3.amazonaws.com/my-bucket/
Stored image my-bucket/image.jpg
Mapped URL https://s3.amazonaws.com/my-bucket/image.jpg

CNAME

Is recommended that you use URLs that match your domain so try to take advantage of using a CNAME record (opens new window).

Another example, Amazon S3 with folder-based storage and custom CNAME (img.domain.com):

Property Value
Bucket my-bucket
Storage URL https://img.domain.com/my-bucket/
Stored image /my-bucket/2020/10/06/image.jpg
Mapped URL https://img.domain.com/my-bucket/2020/10/06/image.jpg

URL resolver

The mapped URL MUST resolve to the given resource. Chevereto won't resolve this URL, it will only handle the mapping. Check the documentation of your external storage to retrieve this URL or how to customize it to use your own domain.

# Storage URL with CDN

Easily add a CDN for each storage you want to use. You only need to go to your CDN provider and create a pull zone for the origin storage URL.

If you are using Amazon S3, the source (origin) URL will be something like this:

https://s3.amazonaws.com/my-bucket/

The CDN URL provided by your CDN service will be something like this:

https://pullzone-url.at.cdn-service.com/

Adding a CNAME record for the above URL will allow you to end up with a Storage URL like this:

https://s3-cdn.domain.com/

# External storage APIs

# Alibaba Cloud OSS

The Alibaba Cloud OSS API allows to upload images to Alibaba Cloud (Aliyun) Object Storage System (OSS) (opens new window).

# Amazon S3

The Amazon S3 API allows to upload images to an Amazon S3 (opens new window) bucket. You will need an Amazon Web Services (opens new window) (AWS) account for this.

  • To setup Amazon S3:
    • Create access credentials from Identity and Access Management (opens new window) console
    • Click on "Create New Users", make sure to enable "Programmatic access"
    • On permissions, associate AmazonS3FullAccess
    • Store the user name, Access Key ID and Secret Access Key at the end of the process
    • Create a bucket from the S3 console (opens new window)
    • Click on "Create a Bucket" and proceed to create a bucket
    • On permissions, make sure "Block new public ACLs" and "Remove public access" are unchecked (Public access settings)
    • Store the bucket name and the region
    • You don't need to setup logging

If you want to use a custom domain follow the CNAME (opens new window) documentation. Otherwise just make sure that the Storage URL ends with /<your_bucket_name>/

# Backblaze B2

The Backblaze B2 API allows to upload images to Backblaze's cloud storage system (opens new window).

# FTP

The FTP API allows to upload images to a server implementing the File Transfer Protocol (opens new window).

# Google Cloud

The Google Cloud API allows to upload images to a Google Cloud Storage bucket. You will need a Google Cloud (opens new window) service account and activate cloud storage (opens new window) for this.

  • To setup Google Cloud Storage:
    • Create a project
    • Go to "APIs & services" dashboard and make sure that "Google Cloud Storage JSON API" is enabled
    • Go to "APIs & services" > "Credentials", click on "Create credentials" then click on "Service account key"
    • Make sure to use the following settings:
      • Select your service account or create a new one.
      • Key type: JSON
      • Your browser will start to download the JSON key file. Store the file contents.
    • Go to "Storage" then click on "Browser"
    • Create a bucket by clicking the "Create bucket" button. Store the bucket name.

# Local

The Local API allows to upload images to any filesystem path in the server.

# Microsoft Azure

The Microsoft Azure API allows to upload images to Microsoft Azure Storage (opens new window).

# OpenStack

The OpenStack API allows to upload images to an OpenStack (opens new window) container.

  • OpenStack configuration for RunAbove:
    • Identity URL: https://auth.Runabove.io/v2.0 (opens new window)
    • Username: Your RunAbove username
    • Password: Your RunAbove password
    • Region: SBG-1 or BHS-1 This is the data center where your container was created
    • Container: Name of your created container
    • Tenant id: Leave it blank
    • Tenant name: Your project id, found on OpenStack Horizon on the left side (CURRENT PROJECT))
    • URL: Your URL to access the container (see RunAbove CNAME (opens new window))

# S3 Compatible

The S3 Compatible API allows to upload images to any server implementing the Amazon S3 standard, also known as "AWS S3 API". The configuration is exactly the same as Amazon S3, but it requires to provide the provider endpoint.

Some providers supporting S3 API are:

  • Ceph
  • DigitalOcean Spaces
  • Dreamhost Cloud Storage
  • IBM COS S3
  • Minio
  • Scaleway
  • StackPath
  • Tencent Cloud Object Storage (COS)
  • Wasabi

# SFTP

The SFTP API allows to upload images to a server implementing the SSH File Transfer Protocol (opens new window).

← Security →