Artur Paikin 3ddf4c7548 Release 6 years ago
..
examples 9a841f693a refactor: rename service-dog -> companion 6 years ago
infra 7f84a3989c Fix certificate for companion @kvz (#1041) 6 years ago
src e5a2694a2d return next page path for ig only when posts exist 6 years ago
test 1b59a6f4fb refactor: migrate provide data formatting to backend 6 years ago
.dockerignore 8367cb643e Attempt at fixing docker build /cc @kiloreux 6 years ago
.eslintrc.json 96388449f6 refactor: use single eslint command 6 years ago
.gitignore 9a841f693a refactor: rename service-dog -> companion 6 years ago
ARCHITECTURE.md 67af833fdb More uppy server -> companion renames (#1037) 6 years ago
Dockerfile 8367cb643e Attempt at fixing docker build /cc @kiloreux 6 years ago
Dockerfile.test 9a841f693a refactor: rename service-dog -> companion 6 years ago
KUBERNETES.md 67af833fdb More uppy server -> companion renames (#1037) 6 years ago
LICENSE 9a841f693a refactor: rename service-dog -> companion 6 years ago
Makefile 9a841f693a refactor: rename service-dog -> companion 6 years ago
README.md 67af833fdb More uppy server -> companion renames (#1037) 6 years ago
docker-compose-dev.yml 9cd8c519b1 Update and fix docker-compose (#1076) 6 years ago
docker-compose-test.yml 9a841f693a refactor: rename service-dog -> companion 6 years ago
docker-compose.yml 9cd8c519b1 Update and fix docker-compose (#1076) 6 years ago
env.test.sh 67af833fdb More uppy server -> companion renames (#1037) 6 years ago
env_example 9cd8c519b1 Update and fix docker-compose (#1076) 6 years ago
nodemon.json 9a841f693a refactor: rename service-dog -> companion 6 years ago
package.json 3ddf4c7548 Release 6 years ago
tsconfig.json 9a841f693a refactor: rename service-dog -> companion 6 years ago

README.md

Companion

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

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 uppy = 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(uppy.app(options))

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

...
var server = app.listen(PORT)

uppy.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 gtihub and want to run it as a standalone server, you may also run the following command from within its directory

npm start

Run as a serverless function

Companion can be deployed as a serverless function to AWS Lambda or other cloud providers through serverless. Check this guide to get started.

After you have cloned the repo go inside examples/serverless:

cd examples/serverless

You can enter your API Keys inside the serverless.yml file:

INSTAGRAM_KEY: <YOUR_INSTAGRAM_KEY>
INSTAGRAM_SECRET: <YOUR_INSTAGRAM_SECRET>

When you are all set install the dependencies and deploy your function:

npm install && sls deploy

See full documentation