Skip to main content
Unlisted page
This page is unlisted. Search engines will not index it, and only users having a direct link can access it.
Version: Developer

Set up the S3 storage provider

The S3 storage provider lets users map their S3 buckets into a container-based Kasm session. Access is provided through the Rclone Docker volume plugin. For reference, see the Rclone S3 documentation.

Configure the storage provider

  1. Log in to the Kasm UI as an administrator.
  2. Select Settings, then Storage, then Add.
  3. Complete the form with the following entries:
FieldValue
NameS3
Storage Provider TypeS3
Enabledchecked
Default Target/s3
Volume Config{ "driver" : "rclone", "driver_opts" : { "type" : "s3", "s3-provider" : "AWS", "s3-env-auth" : "false", "s3-region" : "us-east-1", "uid" : "1000", "gid" : "1000", "allow_other" : "true" } }
Mount Config{}
  1. Click Save.
note

Many of the storage provider examples include default storage driver options used by Rclone. These options work well with Kasm in its default configuration, and administrators can adjust them as needed. The available options often vary by provider plugin, for example Google Drive compared with OneDrive.

The Rclone Docker plugin is installed by default as part of the standard Workspace install. For more information about Rclone driver options, see the Rclone Docker documentation.

S3 storage mapping configuration

  1. From any page, select the profile icon at the top right.

Edit the user profile

Edit Profile
  1. Select the Cloud Storage section, then Add Storage Mapping.

Add a storage mapping from the profile

Add Storage Mapping
  1. Select S3 from the drop-down. Enter the S3 Access Key ID, S3 Secret Access Key, and S3 Bucket, then select Next.

Configure the S3 storage mapping

Configure Storage
  1. On success, Kasm redirects you to the Workspaces dashboard. The new storage mapping appears in the Cloud Storage section of the profile.

The S3 storage mapping in the profile

Storage Mapping
  1. Launch a new container-based session. Confirm that the S3 buckets are mapped inside the session at the /s3 location.

S3 files mapped inside a session

In Session View