README

Provides the Google Drive filesystem driver for Winter CMS using masbug/flysystem-google-drive-ext.

Installation

This plugin is available for installation via Composer.

composer require winter/wn-drivergoogledrive-plugin

Usage

For usage examples of interacting with this driver see the usage examples here: ivanvermeyen/laravel-google-drive-demo#available-routes

Configuration

Example Storage disk configuration using the googledrive storage driver provided by this plugin:

'mygoogledrive' => [
    'driver' => 'googledrive',
    'clientId' => '',
    'clientSecret' => '',
    'refreshToken' => '',
    'folder' => '',
],

See the following Configuration Guides for how to get the values for clientId, clientSecret, refreshToken, & folder.

Configuration Guides

Getting your Client ID and Secret

https://console.developers.google.com/

Create a Project

Create a new project using the dropdown at the top.

After you enter a name, it takes a few seconds before the project is successfully created on the server.

Enable Drive API

Make sure you have the project selected at the top.

Then go to Library and click on "Drive API" under "G Suite APIs".

And then Enable it.

Create Credentials

Go to "Credentials" and click on the tab "OAuth Consent Screen". Fill in a "Product name shown to users" and Save it. Don't worry about the other fields.

Then go back to Credentials, click the button that says "Create Credentials" and select "OAuth Client ID".

Choose "Web Application" and give it a name.

Add https://developers.google.com/oauthplayground in "Authorized redirect URIs". You will need to use this in the next step to get your refresh token. Once you have the token, you can remove the URI.

Click Create and take note of your Client ID and Client Secret.

Getting your Refresh Token

Go to https://developers.google.com/oauthplayground.

Make sure you added this URL to your Authorized redirect URIs in the previous step.

In the top right corner, click the settings icon, check "Use your own OAuth credentials" and paste your Client ID and Client Secret.

In step 1 on the left, scroll to "Drive API v3", expand it and check the first drive scope.

Click "Authorize APIs" and allow access to your account when prompted. There will be a few warning prompts, just proceed.

When you get to step 2, check "Auto-refresh the token before it expires" and click "Exchange authorization code for tokens".

When you get to step 3, click on step 2 again and you should see your refresh token.

Getting your Root Folder

If you want to store files in your Google Drive root directory, then the folder ID can be null. Otherwise, go into your Drive and create a folder and then provide the path to that folder for this value.

winter / wn-drivergoogledrive-plugin

Maintainers

Details