Skip to content

Service for transferring output from encore job with a transfer job in OSC

License

Notifications You must be signed in to change notification settings

Eyevinn/encore-transfer

Repository files navigation

Encore Transfer

Encore Transfer - Service for transferring output from encore job with a transfer job in OSC.

📖 Read the documentation 👀

PRs welcome made with hearth by Eyevinn Slack

This service can be part of a video processing pipeline in Open Source Cloud.

pipeline

Requirements

Installation / Usage

Environment Variables

Variable Description Default value
REDIS_URL URL to the redis server redis:https://localhost:6379
REDIS_QUEUE Name of the redis queue to listen to transfer-queue
PORT Port to bind and listen to 8000
S3_OUTPUT S3 bucket and base folder for output, actual output will be in a subfolder named from the job id
OSC_ACCESS_TOKEN OSC access token for accessing Encore instance in OSC
AWS_ACCESS_KEY_ID_SECRET OSC secret containing AWS access key id for S3_OUTPUT
AWS_SECRET_ACCESS_KEY_SECRET OSC secret containing AWS secret access for S3_OUTPUT

Development

% npm install

Setup necessary environment variables

% export OSC_ACCESS_TOKEN=<personal-access-token>
% export AWS_ACCESS_KEY_ID_SECRET=awsaccesskeyid
% export AWS_SECRET_ACCESS_KEY_SECRET=awssecretaccesskey

Start service

% DEBUG=1 \
  S3_OUTPUT=s3:https://lab-testcontent-store/birme/encore/ \
  REDIS_URL=redis:https://<ip>:<port> npm start

To avoid accidentially commiting API secrets we encourage strongly not to use .env files or similar. Use the in-built functionality in the terminal for these purposes by sourcing env variables from files stored in your home directory outside of the repo.

Contributing

See CONTRIBUTING

License

This project is licensed under the MIT License, see LICENSE.

Support

Join our community on Slack where you can post any questions regarding any of our open source projects. Eyevinn's consulting business can also offer you:

  • Further development of this component
  • Customization and integration of this component into your platform
  • Support and maintenance agreement

Contact [email protected] if you are interested.

About Eyevinn Technology

Eyevinn Technology is an independent consultant firm specialized in video and streaming. Independent in a way that we are not commercially tied to any platform or technology vendor. As our way to innovate and push the industry forward we develop proof-of-concepts and tools. The things we learn and the code we write we share with the industry in blogs and by open sourcing the code we have written.

Want to know more about Eyevinn and how it is to work here. Contact us at [email protected]!