Resound API

The backend that all of Resound's apps hook into. More info about the suite of apps in the wiki

Multi-tenancy

If you are running one instance of resound-api for multiple organizations, one way to do it is with Multi-teinancy

Multi-tenancy would be handled on the API side (this repo). Each group or station would be a separate tenant. For example, kpcc and npr.

To create the tenants, first you need to set the env variable ALLOWED_CORS_URLS. Example: ALLOWED_CORS_URLS=http://kpcc.resound.npr.org,http://why.resound.npr.org

note: 'localhost' and 'lvh' cannot be used as a tenant name.

Then you can run the following rake task, that will create the tenants based on the urls

rake db:create_tenants

The tenants will be based on the first subdomain from the urls defined on ALLOWED_CORS_URLS. For example http://kpcc.resound.npr.org, will generate a tenant named kpcc.

Also, if you want, you can setup a S3 bucket for each tenant. All you need to do, is set the env variable S3_MULTI_TENANT to true, and set the AWS_BUCKET_SUFFIX variable. The variable AWS_BUCKET_SUFFIX will represent the common suffix between the bucket names. If you set it to resound-audio, then all your buckets will need to follow the pattern: TENANT_NAME-resound-audio. Example: kpcc-resound-audio. All the buckets need to be defined under the same AWS account, and region.

Getting Started

These instructions will get you a copy of the latest docker image and run the image on your docker machine.

1. docker pull scprdev/resound-api
2. docker run -d -it -p 80:3000 scprdev/resound-api

Development

This rails app uses the dotenv gem. See .env.example

These steps will run the server for development:

1. Install Ruby
2. Install bundler
3. Install and run database
4. Create an .env file from .env.example
5. Create a secrets.yml from secrets.yml.example
6. rake db:test:prepare
7. bundle install
8. rails s

If you want to run multi tenancy locally you can setup you hosts file. For example, if you want to have a tenant working locally for http://kpcc.resound.npr.org you just need to add 127.0.0.1 kpcc.resound.npr to your hosts file.

Postgres setup

Resound API works with Postgres out of the box.

MySQL setup

Resound is also designed to work with a MySQL database, although it loses some of the full text search capabilities, so search may be slower.

To run Resound API with the MySQL adapter, edit database.yml appropriately. Also comment out the Scenic gem gem 'scenic', '~> 1.4.0' from the Gemfile befure running bundle install

Heroku

1. Need to add ffmpeg build pack, suggested buildpack: https://github.com/jonathanong/heroku-buildpack-ffmpeg-latest
2. Add addons for Postgres and Redis
3. Copy all the variables from .env.example to Config Vars under settings tab and add the proper values
4. Need to set JOB_SYNC to true
5. If you used the suggested ffmpeg build pack, you need to set FFMPEG_PATH to /app/vendor/ffmpeg/ffmpeg. If you want you can check the correct path using the follow setps

• run heroku bash -a your-app-name
• run which ffmpeg
• the output of the previous command is the value you should add under FFMPEG_PATH

6. Need to set the env variable AAC_CODEC to aac

SSL

If you want to force all the requests between the client and the API to be HTTPS, you just need to set this env var FORCE_SSL to true.

Upload via FTP

It is possible to configure resound-api to upload via FTP:

1. Copy shrine_ftp_.rb.example to shrine.rb in the config/initializers directory
2. Either fill in your FTP credentials in this new shrine.rb or pass them in as the environment variables.

Required environment variables for FTP:

• RESOUND_FTP_HOST=ftp.somesite.com
• RESOUND_FTP_USER=ftpusername
• RESOUND_FTP_PASSWD=ftppassword
• RESOUND_FTP_DIR=optional_directory

Prerequisites

Docker

Built With

• Rails 5.0.0
• FFMPEG to transcode WAV to FLAC
• Shrine 2.5.0 for file uploading to S3
• AWS S3 for permanent file storage