Set up the Dropbox storage provider

The Dropbox storage provider lets end users map their Dropbox storage into container-based sessions. Access is provided through the Dropbox OAuth interface and the Rclone Docker volume plugin. For reference, see the Rclone Dropbox documentation.

Create a Dropbox OAuth app

1. Log in to the Dropbox App Console.
2. Select Scoped Access, then Full Dropbox, give the app a name such as Kasm-Example, then click Create app.

Create new App

3. On the next screen, note the App key and App Secret. These are the Client ID and Client Secret in the storage provider configuration.

Authentication Details

4. In the Development users section, click Enable additional users to allow additional accounts to use the app.

Enable Additional Users

5. In the OAuth 2 section, enter the redirect URI, substituting the hostname of the Kasm deployment, then click Add: https://kasm.example.com/api/cloud_storage_callback.

Redirect Settings

6. Select the Permissions tab, confirm that the following permissions are selected, then click Submit:

   account_info.read
   files.metadata.read
   files.metadata.write
   files.content.write
   files.content.read
   sharing.read
   sharing.write

DropBox Permissions

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, using the Client ID and Client Secret from the previous section:

Field	Value
Name	Dropbox
Storage Provider Type	Dropbox
Enabled	checked
Client ID	<client id>
Client Secret	<client secret>
Authorization URL	https://www.dropbox.com/1/oauth2/authorize
Authorization URL Options	{"include_granted_scopes" : "user", "access_type" : "offline", "token_access_type" : "offline"}
Token URL	https://api.dropboxapi.com/1/oauth2/token
Redirect URL	https://<hostname>/api/cloud_storage_callback
Scope	files.metadata.read files.metadata.write files.content.read files.content.write sharing.read sharing.write account_info.read
Default Target	/dropbox
Volume Config	{ "driver" : "rclone", "driver_opts" : { "type" : "dropbox", "uid" : "1000", "gid" : "1000", "allow_other" : "true" } }
Mount Config	{}

4. Click Save.

Dropbox storage mapping configuration

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

Edit Profile

2. Select the Cloud Storage section, then Add Storage Mapping.

Add Storage Mapping

3. Select Dropbox from the drop-down, then select Next.

Configure Storage

4. The Dropbox login page appears. Log in with the desired account.

Login

5. Dropbox asks for consent to provide access to the account. Approve the request.

Approve Kasm

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

Storage Mapping

7. Launch a new container-based session. Confirm that Dropbox is mapped inside the session at the /dropbox location.

In Session View