Set up the Google Drive storage provider

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

Create a Google OAuth app

1. Log in to the Google Developer Console.
2. From the APIs & Services menu, select OAuth consent screen.
3. Select External, then click Create.

caution

This example creates an integration where any Google user can authenticate with the Google Drive storage provider, which is ideal for a public-facing deployment. Choose Internal when only users from your Google Workspace corporate account should authenticate. External types must complete a validation process before use in production systems.

OAuth Consent

4. Provide values for the App Name, User support email, and Developer Contact email.
5. In the Authorized Domains section, enter the top private domain of the Workspaces deployment, for example example.com.
6. Click Save and Continue.

OAuth Registration

7. Click Add or Remove Scopes.
8. In the Update Selected Scopes window, check .../auth/drive, then click Update. When the option is not available, add https://www.googleapis.com/auth/drive to the Manually add scope field and click Add To Table.

OAuth Scope

9. Click Save and Continue.
10. Until the app is fully verified and published, it can only authenticate specific test accounts. Click Add Users to authorize several test Google accounts.
11. Click Save and Continue.
12. In the APIs & Services menu, select Credentials.
13. Select Create Credentials, then OAuth client ID.

Client ID

14. Select Web Application as the Application type, then give the client a name such as Kasm.
15. Click Add URI in the Authorized redirect URIs section, and enter https://<kasm deployment hostname>/api/cloud_storage_callback.
16. Click Create.

Create Client

17. A dialog displays a Client ID and Client Secret. Save these values for the next section. The JSON download also includes URLs needed for the next section.

Client Secret

18. From the main menu of the Google Cloud Console, search for Google Drive API. Open the page, then click Enable when the option is available. No action is needed when the status is already enabled.

Enable Drive

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	Google Drive
Storage Provider Type	Google Drive
Enabled	checked
Client ID	<client id>
Client Secret	<client secret>
Authorization URL	https://accounts.google.com/o/oauth2/auth
Authorization URL Options	{"include_granted_scopes" : "true", "prompt" : "select_account consent", "access_type" : "offline"}
Token URL	https://oauth2.googleapis.com/token
Redirect URL	https://<hostname>/api/cloud_storage_callback
Scope	https://www.googleapis.com/auth/drive
Default Target	/gdrive
Volume Config	{ "driver" : "rclone", "driver_opts" : { "type" : "drive", "uid" : "1000", "gid" : "1000", "allow_other" : "true" } }
Mount Config	{}

4. Click Save.

Google Drive 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 Google Drive from the drop-down, then select Next.

Configure Storage

4. The Google login page appears. Log in with the desired account. This account must be a test user from the OAuth app creation process.

Login

5. When the Google OAuth app is not yet approved, a warning appears. Click Continue.

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 Google Drive is mapped inside the session at the /gdrive location.

In Session View