Peddie Sound File Manager

Installation

System package requirements

Recommended Debian / Ubuntu packages are noted in parenthesis.

MySQL and libmysql Ruby bindings (mysql-server mysql-client libmysql-ruby libmysqlclient-dev)
Ogg Vorbis tools (vorbis-tools)
Nginx web server with X-Accel-Redirect support (nginx)
Git (git)
RVM (require manual install)

Database

You need to create a MySQL database on server and create a config/database.yml.

development:
  adapter: sqlite3
  database: db/development.sqlite3
  pool: 5
  timeout: 5000

# Warning: The database defined as "test" will be erased and
# re-generated from your development database when you run "rake".
# Do not set this db to the same as development or production.
test:
  adapter: sqlite3
  database: db/test.sqlite3
  pool: 5
  timeout: 5000

production:
  adapter: mysql2
  database: 
  username: 
  password:
  pool: 5
  timeout: 5000

RVM

RVM is required on app server.

\curl -sSL https://get.rvm.io | bash -s stable
source ~/.rvm/scripts/rvm
rvm autolibs read-fail  # so that you know what packages are missing without giving your password
# [install any missing system packages]
rvm install 2.0.0

Nginx as a reverse proxy

upstream soundfile_puma {
  server unix:/home/soundfile/rails/shared/tmp/sockets/puma.sock;
}

server {
  # ...
  root /path/to/peddie_soundfile/current/public;

  client_max_body_size 100M;

  try_files $uri/index.html $uri.html $uri @rails;

  location @rails {
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header Host $http_host;
    proxy_redirect off;
    proxy_pass http://soundfile_puma;
  }
}

Sound files are uploaded from client as raw WAV files, and uploading 1 minute of sound file takes roughly 5 MB of data traffic. 100M of client_max_body_size should, in theory, allow users to upload around 20 minutes of sound file per request.

Once uploaded, sound files are then converted to Ogg Vorbis to save disk space.

config/secrets.yml

Although we store session data in the database, it is still recommended that you have a secret config/secrets.yml.

development:
  secret_key_base: 
  
test:
  secret_key_base: 
  
production:
  secret_key_base:

Generate, copy and paste secret_key_bases for each environment by running rake secret.

Google OAuth 2.0 application key

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :google_oauth2, 
    "<CLIENT_ID>", 
    "<CLIENT_SECRET>",
    :access_type => :online
end

Deployment

bundle exec cap production deploy

jiehanzheng/peddie_soundfile