@uppy/companion
Advanced tools
OAuth helper and remote fetcher for Uppy's (https://uppy.io) extensible file upload widget with support for drag&drop, resumable uploads, previews, restrictions, file processing/encoding, remote providers like Dropbox and Google Drive, S3 and more :dog:
Companion is a server integration for Uppy file uploader.
It handles the server-to-server communication between your server and file storage providers such as Google Drive, Dropbox, Instagram, etc. Companion is not a target to upload files to. For this, use a https://tus.io server (if you want resumable) or your existing Apache/Nginx server (if you don't). See here for full documentation
npm install @uppy/companion
If you don't have a Node.js project with a package.json you might want to install/run Companion globally like so: [sudo] npm install -g @uppy/companion@1.x (best check the actual latest version, and use that, so (re)installs are reproducible, and upgrades intentional).
companion may either be used as pluggable express app, which you plug to your already existing server, or it may simply be run as a standalone server:
var express = require('express')
var bodyParser = require('body-parser')
var session = require('express-session')
var companion = require('@uppy/companion')
var app = express()
app.use(bodyParser.json())
app.use(session({secret: 'some secrety secret'}))
...
// be sure to place this anywhere after app.use(bodyParser.json()) and app.use(session({...})
const options = {
providerOptions: {
google: {
key: 'GOOGLE_KEY',
secret: 'GOOGLE_SECRET'
}
},
server: {
host: 'localhost:3020',
protocol: 'http',
},
filePath: '/path/to/folder/'
}
app.use(companion.app(options))
To enable companion socket for realtime feed to the client while upload is going on, you call the socket method like so.
...
var server = app.listen(PORT)
companion.socket(server, options)
Please ensure that the required env variables are set before runnning/using companion as a standalone server. See.
$ companion
If you cloned the repo from GitHub and want to run it as a standalone server, you may also run the following command from within its directory
npm start
Companion can also be deployed to Heroku
mkdir uppy-companion && cd uppy-companion
git init
echo 'export COMPANION_PORT=$PORT' > .profile
echo 'node_modules' > .gitignore
echo '{
"name": "uppy-companion",
"version": "1.0.0",
"scripts": {
"start": "companion"
},
"dependencies": {
"@uppy/companion": "^1.13.1"
}
}' > package.json
npm i
git add . && git commit -am 'first commit'
heroku create
git push heroku master
Make sure you set the required environment variables.
2.11.0
Released: 2022-05-30
| Package | Version | Package | Version | | ------------------------- | ------- | ------------------------- | ------- | | @uppy/angular | 0.3.1 | @uppy/progress-bar | 2.1.1 | | @uppy/audio | 0.3.2 | @uppy/provider-views | 2.1.1 | | @uppy/aws-s3 | 2.2.0 | @uppy/react | 2.2.1 | | @uppy/aws-s3-multipart | 2.4.0 | @uppy/react-native | 0.3.1 | | @uppy/box | 1.0.7 | @uppy/redux-dev-tools | 2.1.0 | | @uppy/companion | 3.6.0 | @uppy/screen-capture | 2.1.1 | | @uppy/companion-client | 2.2.0 | @uppy/status-bar | 2.2.1 | | @uppy/compressor | 0.3.0 | @uppy/store-default | 2.1.0 | | @uppy/core | 2.3.0 | @uppy/store-redux | 2.1.0 | | @uppy/dashboard | 2.3.0 | @uppy/thumbnail-generator | 2.2.0 | | @uppy/drag-drop | 2.1.1 | @uppy/transloadit | 2.3.0 | | @uppy/dropbox | 2.0.7 | @uppy/tus | 2.4.0 | | @uppy/facebook | 2.0.7 | @uppy/unsplash | 2.1.0 | | @uppy/file-input | 2.1.1 | @uppy/url | 2.1.1 | | @uppy/form | 2.0.6 | @uppy/utils | 4.1.0 | | @uppy/golden-retriever | 2.1.0 | @uppy/vue | 0.4.8 | | @uppy/google-drive | 2.1.1 | @uppy/webcam | 2.2.1 | | @uppy/image-editor | 1.3.0 | @uppy/xhr-upload | 2.1.1 | | @uppy/informer | 2.1.0 | @uppy/zoom | 1.1.1 | | @uppy/instagram | 2.1.1 | @uppy/robodog | 2.7.0 | | @uppy/onedrive | 2.1.1 | uppy | 2.11.0 |
require call (Antoine du Hamel / #3737)onShouldRetry as option to @uppy/tus (Merlijn Vos / #3720)vite-plugin-jsx-commonjs plugin on dev env (Antoine du Hamel / #3749)build:locale-pack script (Antoine du Hamel / #3764).d.ts files (Antoine du Hamel / #3754)FAQs
OAuth helper and remote fetcher for Uppy's (https://uppy.io) extensible file upload widget with support for drag&drop, resumable uploads, previews, restrictions, file processing/encoding, remote providers like Dropbox and Google Drive, S3 and more :dog:
The npm package @uppy/companion receives a total of 21,103 weekly downloads. As such, @uppy/companion popularity was classified as popular.
We found that @uppy/companion demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncovered a malicious PyPI package exploiting Deezer’s API to enable coordinated music piracy through API abuse and C2 server control.
Research
The Socket Research Team discovered a malicious npm package, '@ton-wallet/create', stealing cryptocurrency wallet keys from developers and users in the TON ecosystem.
Security News
Newly introduced telemetry in devenv 1.4 sparked a backlash over privacy concerns, leading to the removal of its AI-powered feature after strong community pushback.