---
myst:
  html_meta:
    "description lang=en": "AWS S3 Storage Provider configuration guide for Kasm Workspaces."
    "keywords": "AWS, S3, Storage Provider, Storage Mapping, Cloud Storage"
    "property=og:locale": "en_US"
---
```{title} S3 Storage Provider Setup
```

## S3 Storage Provider Setup

The [S3](https://aws.amazon.com/s3/) Storage Provider can be used to allow users to map in their S3 buckets into their container-based
Kasm Session. Access is provided via the [Rclone](https://rclone.org) Docker volume plugin.

Reference Docs:

- <https://rclone.org/s3/>


### Kasm Storage Provider Config

1. Log into the Kasm UI as an administrator.
2. Select **Settings** -> **Storage** -> **Add**.
3. Update the form with the following entries


```{eval-rst}
+-------------------------------+--------------------------------------------------------------------------------------------------------------------+
| Name                          | :code:`S3`                                                                                                         |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------+
| Storage Provider Type         | :code:`S3`                                                                                                         |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------+
| Enabled                       | :code:`checked`                                                                                                    |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------+
| Default Target                | :code:`/s3`                                                                                                        |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------+
| Volume Config                 | .. code-block:: json                                                                                               |
|                               |                                                                                                                    |
|                               |    {                                                                                                               |
|                               |         "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                  | :code:`{}`                                                                                                         |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------+
```


```{include} /guide/storage_providers/rclone.md
```


4. Click **Save** to save the changes.


```{include} /user_guide/storage_providers/s3.md
```