slug |
---|
/onedrive |
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
import UppyCdnExample from '/src/components/UppyCdnExample';
The @uppy/onedrive
plugin lets users import files from their
OneDrive account.
:::tip
Try out the live example or take it for a spin in StackBlitz.
:::
When you want to let users import files from their OneDrive account.
A Companion instance is required for the OneDrive plugin to work. Companion handles authentication with OneDrive, downloads the files, and uploads them to the destination. This saves the user bandwidth, especially helpful if they are on a mobile connection.
You can self-host Companion or get a hosted version with any Transloadit plan.
npm install @uppy/onedrive
yarn add @uppy/onedrive
Using OneDrive requires setup in both Uppy and Companion.
import Uppy from '@uppy/core';
import Dashboard from '@uppy/dashboard';
import OneDrive from '@uppy/onedrive';
import '@uppy/core/dist/style.min.css';
import '@uppy/dashboard/dist/style.min.css';
new Uppy()
.use(Dashboard, { inline: true, target: '#dashboard' })
.use(OneDrive, { companionUrl: 'https://your-companion.com' });
To sign up for API keys, go to the Azure Platform from Microsoft.
Create a project for your app if you don’t have one yet.
The app page has a "Redirect URIs"
field. Here, add:
https://$YOUR_COMPANION_HOST_NAME/onedrive/redirect
If you are using Transloadit hosted Companion:
https://api2.transloadit.com/companion/onedrive/redirect
Go to the “Manifest” tab, and find the "signInAudience"
key.
Change it to "signInAudience": "AzureADandPersonalMicrosoftAccount"
, and click
“Save”.
Go to the “Overview” tab.
Copy the Application (client) ID
field - this will be your Oauth client ID.
Go to the “Certificates & secrets” tab, and click “+ New client secret”.
Copy the Value
field - this will be your OAuth client secret.
Configure the OneDrive key and secret in Companion. With the standalone Companion server, specify environment variables:
export COMPANION_ONEDRIVE_KEY="OneDrive Application ID"
export COMPANION_ONEDRIVE_SECRET="OneDrive OAuth client secret value"
When using the Companion Node.js API, configure these options:
companion.app({
providerOptions: {
onedrive: {
key: 'OneDrive Application ID',
secret: 'OneDrive OAuth client secret value',
},
},
});
A unique identifier for this plugin (string
, default: 'OneDrive'
).
Title / name shown in the UI, such as Dashboard tabs (string
, default:
'OneDrive'
).
DOM element, CSS selector, or plugin to place the drag and drop area into
(string
, Element
, Function
, or UIPlugin
, default:
Dashboard
).
URL to a Companion instance (string
, default: null
).
Custom headers that should be sent along to Companion on
every request (Object
, default: {}
).
The valid and authorised URL(s) from which OAuth responses should be accepted
(string
or RegExp
or Array
, default: companionUrl
).
This value can be a string
, a RegExp
pattern, or an Array
of both. This is
useful when you have your Companion running on several hosts.
Otherwise, the default value should do fine.
This option correlates to the
RequestCredentials value
(string
, default: 'same-origin'
).
This tells the plugin whether to send cookies to Companion.
export default {
strings: {
pluginNameOneDrive: 'OneDrive',
},
};