Skip to content

How to Configure an External Storage

Instructions

View the list of External Storages

  1. Sign in to Flywheel as a Site Admin.
  2. Click Interfaces in the left menu under the ADMIN section.
  3. Click the External Storage tab.

mceclip0.png

View and Configure an External Storage

  1. Click on the pencil icon for the external storage you are interested in

  2. View and optionally modify the dialog box with storage details

    • Label: The name of the storage provider within Flywheel.
    • Provider: The type of storage provider (S3, Azure, GCP, AHI, File Store).
    • Bucket: The storage Bucket.
    • Prefix or Path: The prefix to the storage location in an object storage bucket. Or, the path to the storage location in a File System.
    • Permissions: Level of access for this bucket. Can be Site, a Group, or a Project.
    • Permission Mode: Which transfer directions are enabled for this storage — Import only, Export only, or Both. At least one direction must be enabled. See Flywheel Permissions for an overview of the modes.

    mceclip6.png

  3. Click Save and Test to save the new settings and start a connection test. If the test is successful, Flywheel was able to connect to the bucket.

Info

The Prefix (or Path) setting cannot be modified after an External Storage is created.

If a different Prefix (or Path) setting is needed, either:

  1. Create a new External Storage with the desired settings, or
  2. Override the storage settings when starting an Import or Export.

Registering Storage via the CLI

External Storage registrations can also be created or updated using the New CLI (flyw). The CLI accepts both absolute and relative paths when registering or updating storage providers.

For complete command syntax, refer to the flyw CLI documentation.

Troubleshooting

An unsuccessful test is likely due to one of the following reasons:

  • The modified bucket does not exist
  • The Provider was changed without changing the access keys
  • The access keys are no longer valid