Nationwide Polamorous Matrimony
    Have ideas to improve npm?Join in the discussion! »

    @uppy/companion
    TypeScript icon, indicating that this package has built-in type declarations

    2.7.0 • Public • Published

    Companion

    Uppy logo — a superman puppy in a pink suit

    Build Status

    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 already existing server, or it may simply be run as a standalone server:

    Plug to already existing 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)

    Run as standalone server

    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

    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": "^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.

    See full documentation

    Install

    npm i @uppy/companion

    DownloadsWeekly Downloads

    4,280

    Version

    2.7.0

    License

    ISC

    Unpacked Size

    239 kB

    Total Files

    114

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar