Docs
- Getting Started
- SME Uploader
- Companion
- List of Plugins
- Common Plugin Options
- Custom Stores
- Locale Packs
UI Elements
Sources
- Drag & Drop
- File Input
- Webcam
- Provider Plugins
- ⓒ Dropbox
- ⓒ Google Drive
- ⓒ Facebook
- ⓒ Instagram
- ⓒ OneDrive
- ⓒ Zoom
- ⓒ Import From URL
Destinations
File Processing
- Image Editor
- Robodog Introduction
- Robodog File Picker
- Robodog Form
- Robodog Upload
- Robodog Dashboard
- Transloadit
Miscellaneous
Contributing
Provider Plugins
The Provider plugins help you connect to your accounts with remote file providers such as Dropbox, Google Drive, Instagram and remote URLs (importing a file by pasting a direct link to it). Because this requires server-to-server communication, they work tightly with Companion to manage the server-to-server authorization for your account. Almost all of the communication (file download/upload) is done on the server-to-server end, so this saves you the stress and bills of data consumption on the client.
As of now, the supported providers are Dropbox, GoogleDrive, Instagram, and URL.
Usage of the Provider plugins is not that different from any other acquirer plugin, except that it takes an extra option companionUrl, which specifies the URL to the Companion that you are running. This allows SME Uploader to know what server to connect to when datacenter operations are required by the provider plugin.
Here’s a quick example:
const SmeUploader = require('@sme-uploader/core'); const Dashboard = require('@sme-uploader/dashboard'); const uploader = new SmeUploader(); uploader.use(Dashboard, { trigger: '#pick-files' }); // for Google Drive const GoogleDrive = require('@sme-uploader/google-drive'); uploader.use(GoogleDrive, {target: Dashboard, companionUrl: 'http://localhost:3020'}); // for Dropbox const Dropbox = require('@sme-uploader/dropbox'); uploader.use(Dropbox, {target: Dashboard, companionUrl: 'http://localhost:3020'}); // for Instagram const Instagram = require('@sme-uploader/instagram'); uploader.use(Instagram, {target: Dashboard, companionUrl: 'http://localhost:3020'}); // for URL const Url = require('@sme-uploader/url'); uploader.use(Url, {target: Dashboard, companionUrl: 'http://localhost:3020'}); |
⚠️ The Dashboard plugin is recommended as a universal container to all Provider plugins. It also comes with file previews, progress reporting and more. If you are using the Dashboard, it already comes with all the nessesary styles and functionality for Providers to work well.
If you are feeling adventurous, you can technically use a Provider plugin separately, without the Dashboard. Make sure to then include @sme-uploader/provider-views/dist/style.css (or style.min.css) CSS file. But this is experimental, not officialy supported and not recommended.