Tips and Resources For Setting Up Website From Ground Up

# Load DSL and Setup Up Stages
require 'capistrano/setup'

# Includes default deployment tasks
require 'capistrano/deploy'

# Includes tasks from other gems included in your Gemfile
#
# For documentation on these, see for example:
#
#   https://github.com/capistrano/rvm
#   https://github.com/capistrano/rbenv
#   https://github.com/capistrano/chruby
#   https://github.com/capistrano/bundler
#   https://github.com/capistrano/rails
#
# require 'capistrano/rvm'
# require 'capistrano/rbenv'
# require 'capistrano/chruby'

# Add bundler support
require 'capistrano/bundler'
# Add assets precompile support
require 'capistrano/rails/assets'
# Add database migration support
require 'capistrano/rails/migrations'
# Add unicorn support
require 'capistrano3/unicorn'

# Loads custom tasks from `lib/capistrano/tasks' if you have any defined.
Dir.glob('lib/capistrano/tasks/*.rake').each { |r| import r }

# config valid only for Capistrano 3.4
lock '3.4.0'

# set the directory the code deployed to on server
# # Default deploy_to directory is /var/www/my_app
set :deploy_to, '/your_project'

# set your user name on server
set :user, "username"

# set the application name
set :application, 'app_name'

# set the repository address
set :repo_url, 'git@github.com:app_name.git'

# set the deployed branch
# Default branch is :master
# ask :branch, proc { `git rev-parse --abbrev-ref HEAD`.chomp }.call
set :branch, "your_branch"

# files we want sym linking to specific entries in shared.
# Default value for :linked_files is []
set :linked_files, %w{config/database.yml config/secrets.yml}

# dirs we want symlinking to shared
# Default value for linked_dirs is []
set :linked_dirs, %w{log tmp/pids tmp/cache tmp/sockets vendor/bundle public/system lib/data}

# Set application environment
set :rails_env, "production"

# Set deploy method
set :deploy_via, :copy

#########################################
# Set this configurations if you don't have sudo permission

# Deploy without using sudo if you are not sudo
set :use_sudo, false

# set tmp dir to your home directory(when you have no sudo permission)
set :tmp_dir, "/home/users/your_username/tmp"

# Default value for default_env is {}
# If you installed ruby locally(in your home directory, you need to specify its location to Capistrano)
set :default_env, { path: "/home/users/your_username/.rvm/gems/ruby-2.1.5/wrappers:$PATH" }

#########################################
# These are default settings that you probably don't need to change

# set software configuration management tool
# Default value for :scm is :git
# set :scm, :git

# Deploy console log format setting
# Default value for :format is :pretty
# set :format, :pretty

# Default value for :log_level is :debug
# set :log_level, :debug

# indicate use of sudo without password
# Default value for :pty is false
# set :pty, false

# Set the number of releases you want to keep
# Default value for keep_releases is 5
# set :keep_releases, 5

# Unicorn settings(We'll talk about it soon, just showcase the typical usage here)
set :unicorn_pid, -> { "#{shared_path}/tmp/pids/unicorn.pid" }
set :unicorn_config_path, "config/unicorn.rb"
set :unicorn_rack_env, 'deployment' # "development", "deployment", or "none"

namespace :deploy do

  desc 'Restart application'
  task :restart do
    on roles(:app), in: :sequence, wait: 5 do
      invoke 'unicorn:legacy_restart'
    end
  end

  after :publishing, 'deploy:restart'
  after :finishing,  'deploy:cleanup'
end

# After deploy cleanup, clean up old version dependencies.
namespace :bundle do
  task :clean do
    on roles(:web) do
      within release_path do
        with rails_env: fetch(:rails_env) do
          execute :bundle, :clean
        end
      end
    end
  end
end

after "deploy:cleanup", "bundle:clean"

# set deploy stage to production
set :stage, :production

# add your domain name and username on server
server 'mydomain.com', roles: %w{web app db}, user: 'username'

# Sample verbose configuration file for Unicorn (not Rack)
#
# This configuration file documents many features of Unicorn
# that may not be needed for some applications. See
# http://unicorn.bogomips.org/examples/unicorn.conf.minimal.rb
# for a much simpler configuration file.
#
# See http://unicorn.bogomips.org/Unicorn/Configurator.html for complete
# documentation.

# app path in production environment
app_path = File.dirname(File.dirname(Dir.pwd))

# Use at least one worker per core if you're on a dedicated server,
# more will usually help for _short_ waits on databases/caches.
# But to be honest, for a small app 2 process is enough.
worker_processes (ENV['RAILS_ENV'] == 'production' ? 2 : 1)

# Since Unicorn is never exposed to outside clients, it does not need to
# run on the standard HTTP port (80), there is no reason to start Unicorn
# as root unless it's from system init scripts.
# If running the master process as root and the workers as an unprivileged
# user, do this to switch euid/egid in the workers (also chowns logs):
# user "unprivileged_user", "unprivileged_group"

# Help ensure your application will always spawn in the symlinked
# "current" directory that Capistrano sets up.
# working_directory "/path/to/app/current"
# available in 0.94.0+
working_directory "#{app_path}/current"

# listen on both a Unix domain socket and a TCP port,
# we use a shorter backlog for quicker failover when busy
listen app_path + '/shared/tmp/sockets/unicorn.sock', backlog: 64

# For development, you may want to listen on port 3000 so that
# you can make sure your unicorn.rb file is soundly configured.
listen(3000, backlog: 64) if ENV['RAILS_ENV'] == 'development'

# default timeout is 60 seconds
timeout 60

# Set the location of the unicorn pid file. This should match what we put in the
# unicorn init script later.
pid app_path + '/shared/tmp/pids/unicorn.pid'

# You should define your stderr and stdout here. If you don't, stderr defaults
# to /dev/null and you'll lose any error logging when in daemon mode.
stderr_path app_path + '/shared/log/unicorn.stderr.log'
stdout_path app_path + '/shared/log/unicorn.stdout.log'

# combine Ruby 2.0.0 dev or REE with "preload_app true" for memory savings
# http://rubyenterpriseedition.com/faq.html#adapt_apps_for_cow
preload_app true
GC.respond_to?(:copy_on_write_friendly=) and
  GC.copy_on_write_friendly = true

# Enable this flag to have unicorn test client connections by writing the
# beginning of the HTTP headers before calling the application.  This
# prevents calling the application for connections that have disconnected
# while queued.  This is only guaranteed to detect clients on the same
# host unicorn runs on, and unlikely to detect disconnects even on a
# fast LAN.
check_client_connection false

# local variable to guard against running a hook multiple times
run_once = true

before_fork do |server, worker|
  # the following is highly recomended for Rails + "preload_app true"
  # as there's no need for the master process to hold a connection
  defined?(ActiveRecord::Base) and
    ActiveRecord::Base.connection.disconnect!

  # Occasionally, it may be necessary to run non-idempotent code in the
  # master before forking.  Keep in mind the above disconnect! example
  # is idempotent and does not need a guard.
  if run_once
    # do_something_once_here ...
    run_once = false # prevent from firing again
  end

  # The following is only recommended for memory/DB-constrained
  # installations.  It is not needed if your system can house
  # twice as many worker_processes as you have configured.
  #
  # This allows a new master process to incrementally
  # phase out the old master process with SIGTTOU to avoid a
  # thundering herd (especially in the "preload_app false" case)
  # when doing a transparent upgrade.  The last worker spawned
  # will then kill off the old master process with a SIGQUIT.

  # old_pid = "#{server.config[:pid]}.oldbin"
  # if old_pid != server.pid
  #   begin
  #     sig = (worker.nr + 1) >= server.worker_processes ? :QUIT : :TTOU
  #     Process.kill(sig, File.read(old_pid).to_i)
  #   rescue Errno::ENOENT, Errno::ESRCH
  #   end
  # end


  # Throttle the master from forking too quickly by sleeping.  Due
  # to the implementation of standard Unix signal handlers, this
  # helps (but does not completely) prevent identical, repeated signals
  # from being lost when the receiving process is busy.
  # sleep 1

end

after_fork do |server, worker|
  # per-process listener ports for debugging/admin/migrations
  # addr = "127.0.0.1:#{9293 + worker.nr}"
  # server.listen(addr, :tries => -1, :delay => 5, :tcp_nopush => true)

  # the following is *required* for Rails + "preload_app true",
  defined?(ActiveRecord::Base) and
    ActiveRecord::Base.establish_connection

  # if preload_app is true, then you may also want to check and
  # restart any other shared sockets/descriptors such as Memcached,
  # and Redis.  TokyoCabinet file handles are safe to reuse
  # between any number of forked children (assuming your kernel
  # correctly implements pread()/pwrite() system calls)
end

# This goes to /etc/nginx/nginx.conf (or where nginx is installed)

user www-data;
worker_processes 2;
pid /var/run/nginx.pid;

events {
  worker_connections 768;
}

http {

  ##
  # Basic Settings
  ##

  sendfile on;
  tcp_nopush on;
  tcp_nodelay off;
  keepalive_timeout 65;
  types_hash_max_size 2048;
  server_tokens off;

  # server_names_hash_bucket_size 64;
  # server_name_in_redirect off;

  include /etc/nginx/mime.types;
  default_type application/octet-stream;

  ##
  # Logging Settings
  ##

  access_log /var/log/nginx/access.log;
  error_log /var/log/nginx/error.log;

  ##
  # Gzip Settings
  ##

  gzip on;
  gzip_disable "msie6";
  gzip_vary on;
  gzip_proxied any;
  gzip_min_length 500;
  gzip_http_version 1.1;
  gzip_types text/plain text/css application/json application/x-javascript text/xml application/xml application/xml+rss text/javascript;

  ##
  # Unicorn Rails
  ##

  upstream unicorn {
    server unix:/your_project/current/tmp/sockets/unicorn.sock fail_timeout=0;
  }

  ##
  # Virtual Host Configs
  ##
  include /etc/nginx/sites-enabled/*;

}

# This file goes to /etc/nginx/sites-available/default
# Then create a soft symlink of this file in /etc/nginx/sites-enabled/default

server {
  listen 80;
  server_name your_domain.name;
  root /your_project/current/public;

  client_max_body_size 1G;

  keepalive_timeout 300;

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

  location @unicorn {
    proxy_set_header X-Forward-For $proxy_add_x_forwarded_for;
    proxy_set_header Host $http_host;
    proxy_set_header X-Forward_Proto $scheme;
    proxy_redirect off;
    # This passes requests to unicorn, as defined in /etc/nginx/nginx.conf
    proxy_pass http://unicorn;
    proxy_read_timeout 300s;
    proxy_send_timeout 300s;
  }

  # You can override error pages by redirecting the requests to a file in your
  # application's public folder, if you so desire:

  error_page 500 502 503 504 /500.html;
  location = /500.html {
    root /your_project/current/public;
  }

  error_page 404 /404.html;
    location = /404.html {
    root /your_project/current/public;
  }
}