Skip to main content

Uppy 5.0 is here with headless components and hooks

Import from URL

The @uppy/url plugin allows users to import files from the internet. Paste any URL and it will be added!

tip

Try out the live example or take it for a spin in StackBlitz.

When should I use this?​

When you want to let users import files any URL.

A Companion instance is required for the URL plugin to work. 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.

note

Companion has Server Side Request Forgery (SSRF) protections built-in so you don’t have to worry about the security implications of arbitrary URLs.

npm install @uppy/url

Use​

Using @uppy/url only requires setup in Uppy.

Use in Uppy​

import Uppy from '@uppy/core';
import Dashboard from '@uppy/dashboard';
import Url from '@uppy/url';

import '@uppy/core/css/style.min.css';
import '@uppy/dashboard/css/style.min.css';
import '@uppy/url/css/style.min.css';

new Uppy()
	.use(Dashboard, { inline: true, target: '#dashboard' })
	.use(Url, { companionUrl: 'https://your-companion.com' });

Use with Transloadit​

import { COMPANION_URL, COMPANION_ALLOWED_HOSTS } from '@uppy/transloadit';
import Url from '@uppy/url';

uppy.use(Url, {
	companionUrl: COMPANION_URL,
	companionAllowedHosts: COMPANION_ALLOWED_HOSTS,
});

You may also hit rate limits, because the OAuth application is shared between everyone using Transloadit.

To solve that, you can use your own OAuth keys with Transloadit’s hosted Companion servers by using Transloadit Template Credentials. Create a Template Credential on the Transloadit site. Select “Companion OAuth” for the service, and enter the key and secret for the provider you want to use. Then you can pass the name of the new credentials to that provider:

import { COMPANION_URL, COMPANION_ALLOWED_HOSTS } from '@uppy/transloadit';
import Url from '@uppy/url';

uppy.use(Url, {
	companionUrl: COMPANION_URL,
	companionAllowedHosts: COMPANION_ALLOWED_HOSTS,
	companionKeysParams: {
		key: 'YOUR_TRANSLOADIT_API_KEY',
		credentialsName: 'my_companion_dropbox_creds',
	},
});

Use in Companion​

Companion supports this plugin out-of-the-box, however it must be enabled in Companion with the enableUrlEndpoint / COMPANION_ENABLE_URL_ENDPOINT option.

API​

Options​

id​

A unique identifier for this plugin (string, default is a unique ID for each plugin).

title​

Title / name shown in the UI, such as Dashboard tabs (string, default is the name of the plugin).

target​

DOM element, CSS selector, or plugin to place the drag and drop area into (string, Element, Function, or UIPlugin, default: Dashboard).

companionUrl​

URL to a Companion instance (string, default: null).

companionHeaders​

Custom headers that should be sent along to Companion on every request (Object, default: {}).

companionAllowedHosts​

The valid and authorised URL(s) from which OAuth responses should be accepted (string or RegExp or Array). This option is useful when you have your Companion running on several hosts. Otherwise, the default value should do fine, which uses the origin of companionUrl.

This value can be a string, a RegExp pattern, or an Array of these. Strings are evaluated as regular expressions too and will be wrapped in a RegExp like so:

new RegExp(`^${value}$`);

Important: You must escape regex characters like ., or you might open your app up to security vulnerabilities.

  • Example correct strings
    • '^(?:.*\\.)?example\.com$' matches example.com and all of its subdomains.
    • 'https://example\.com' matches https://example.com only.
  • Example vulnerability: 'https://www.example.com' would allow an attacker with the domain wwwxexample.com to forge and inject a fraudulent token into Uppy.

companionCookiesRule​

This option correlates to the RequestCredentials value (string, default: 'same-origin').

This tells the plugin whether to send cookies to Companion.

locale​

An object with strings property containing additional i18n strings. The key is the i18n key and the value is the English string.

Example:

{
	strings: {
		someKey: 'Some English string',
	},
}

storage​

A custom storage to be used for the plugin’s persistent data. Type AsyncStore, default is LocalStorage.