@uppy/companion

Companion

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

Install

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).

Usage

companion may either be used as pluggable express app, which you plug to your existing server, or it may also be run as a standalone server:

Plug to an existing server

import express from 'express'
import bodyParser from 'body-parser'
import session from 'express-session'
import companion from '@uppy/companion'

const 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: {
    drive: {
      key: 'GOOGLE_KEY',
      secret: 'GOOGLE_SECRET',
    },
  },
  server: {
    host: 'localhost:3020',
    protocol: 'http',
  },
  filePath: '/path/to/folder/',
}

const { app: companionApp } = companion.app(options)
app.use(companionApp)

To enable companion socket for realtime feed to the client while upload is going on, you call the socket method like so.

// ...
const server = app.listen(PORT)

companion.socket(server)

Run as standalone server

Please make sure 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

Deploy to heroku

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": "latest"
  }
}' > 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.

See full documentation

Changelog

4.7.0

Released: 2024-11-11

| Package | Version | Package | Version | | --------------- | ------- | --------------- | ------- | | @uppy/aws-s3 | 4.1.2 | @uppy/tus | 4.1.4 | | @uppy/companion | 5.1.4 | uppy | 4.7.0 | | @uppy/locales | 4.3.0 | | |

• @uppy/aws-s3: clarify and warn when incorrect buckets settings are used (Mikael Finstad / #5505)
• @uppy/tus: fix event upload-success response.body.xhr (ItsOnlyBinary / #5503)
• @uppy/companion: Enable CSRF protection in grant (OAuth2) (Mikael Finstad / #5504)
• @uppy/locales: Add ms_MY (Malay) locale (Salimi / #5488)