WebROaR User Guide

sudo gem install webroar
sudo webroar install

git clone git://github.com/webroar/webroar.git
cd webroar
sudo rake install

rake db:create
rake db:migrate

sudo webroar start
sudo webroar stop
sudo webroar restart

sudo webroar start <Application Name>
sudo webroar stop <Application Name>
sudo webroar restart <Application Name>

capify .

set :application, "myapp"

set :scm,:none
set :repository, "."

set :copy_cache, "/tmp/my-app"
set :copy_compression,:gzip
set :deploy_via,:copy
set :copy_exclude, [".git/*", "log/*", "Capfile", "config/deploy.rb", "*~", ".*"]

set :password, 'password'
set :use_sudo, false
set :user, 'username'
set :port, 22

set :deploy_to, "path-to-your-web-app-directory/#{application}"

################################
# Parameters used to add application to the server
################################
set :resolver, "/#{application.gsub(' ','_')}"
set :path, "#{deploy_to}/current"
set :app_type, "rails"
set :environment, "production"
set :analytics, "--analytics" # ' ' (blank) to disable analytics
set :min_workers, "4"
set :max_workers, "8"
set :run_as_user, "#{user}"
################################

role :app, "server"
role :web, "server"
role :db,  "server", :primary => true

#role :db,  "your slave db-server here"

namespace :deploy do

  [:stop, :start, :restart].each do |action|
    desc "#{action.to_s.capitalize} the application."
    task action, :roles => :app do
      run "#{sudo} webroar #{action.to_s} #{application.to_s}"
    end
  end

  desc "Add application to the server"
  task :add, :roles => :app do
    run "#{sudo} webroar add '#{application}' --resolver'#{resolver}' \
    --path'#{path}' -type'#{app_type}' -environment'#{environment}' #{analytics} \
    --min-workers#{min_workers} --max-workers#{max_workers} \
    --run-as-user'#{run_as_user}'"
  end

  desc "Remove application from the server"
  task :remove, :roles => :app do
    run "#{sudo} webroar remove '#{application}'"
  end

end

after "deploy:update",  "deploy:restart"

cap deploy:setup

cap deploy

cap deploy:add

cap deploy:stop
cap deploy:start
cap deploy:restart

  require 'rubygems'
  require 'merb-core'
  Merb::Config.setup(:merb_root   => ENV['APP_ROOT'],
                     :environment => ENV['APP_ENV'],
                     :path_prefix => ENV['APP_BASE_URI'])
  Merb.environment = Merb::Config[:environment]
  Merb.root = Merb::Config[:merb_root]
  Merb::BootLoader.run
  run Merb::Rack::Application.new

  require 'rubygems'
  require 'rack'
  require 'sinatra'
  set :env, ENV['APP_ENV'] || :production
  set :raise_errors, true
  run Sinatra::Application

sudo webroar uninstall
sudo gem uninstall webroar

sudo webroar test

  WebROaR - Ruby Application Server

    Usage:
      webroar -h/--help
      webroar -v/--version
      webroar command [argument] [options...]

    Examples:
      webroar install
      webroar help

    Further help:
      webroar help commands      list all 'webroar' commands
      webroar help <COMMAND>     show help on COMMAND

    install            Install the server
    uninstall          Uninstall the server

    start [APPNAME]    Start the server or an application
    stop [APPNAME]     Stop the server or an application
    restart [APPNAME]  Restart the server or an application

    add APPNAME        Deploy an application on server
    remove APPNAME     Remove an application from server

    test               Run the test suite

  For help on a particular command, use 'webroar help COMMAND'.

  Usage:
    webroar install [options]

  Options:
    -L                     Additional library paths to be used for linking of
                           the server
    -I                     Additional include paths to be used for compiling of
                           the server
    -s, --ssl-support      Install the server with SSL support
    -d, --debug-build      Compile the server as a debug build to output
                           extremely verbose logs

  The following options would make the install non-interactive by suppressing
  the questions prompted by the installer

    -P, --port             Server port number
    -i, --import           Import configuration, logs and admin panel data from
                           the previous installation
        --no-import        Do not import configuration, logs and admin panel
                           data from the previous installation
    -u, --username         Username for the administrator account of server's
                           admin panel
    -p, --password         Password for the administrator account of server\'s
                           admin panel

  Summary:
    Install the server

  Usage:
    webroar uninstall

  Summary:
    Uninstall the server

  Usage:
    webroar start [APPNAME ...]

  Arguments:
    APPNAME        Name of the application

  Summary:
    Start the server or an application

  Description:
    'start' command without any arguments starts the server. One can start
    multiple applications together by passing multiple names.

  Usage:
    webroar stop [APPNAME ...]

  Arguments:
    APPNAME        Name of the application

  Summary:
    Stop the server or an application

  Description:
    'stop' command without any arguments stops the server. One can stop multiple
    applications together by passing multiple names.

  Usage:
    webroar restart [APPNAME ...]

  Arguments:
    APPNAME        Name of the application

  Summary:
    Restart the server or an application

  Description:
    'restart' command without any arguments restarts the server. One can restart
    multiple applications together by passing multiple names.

  Usage:
    webroar add APPNAME -R ... -D ... -U ... [options]

  Arguments:
    APPNAME       Name of the application

  Options:
    -R, --resolver
          Resolver to identify the application. Set it to '/' if you would like
          to run the application on the root domain. e.g. http://yourserver:port/.
          Else set the relevant base URI with which you would like to access the
          application, e.g. '/app1' if you want the application to be accessible
          via http://yourserver:port/app1.
          If you would like to set a virtual host for your application e.g.
          www.company1.com, please specify it here. You can also host this
          application on a particular subdomain e.g. app1.company1.com.
          Wildcard '*' can also be used in defining the virtual host name,
          but it should only be used either at the start or the end. Prefix the
          virtual host name with tilde(~), if a wildcard is used in defining it.
          e.g. (i) ~*.server.com (ii) ~www.server.* (iii) ~*.server.*
    -D, --path
          Complete path for your application root directory: e.g.
          /home/someuser/webapps/app1
    -U, --run-as-user
          Name of the user with whose privileges you would like to run the
          application (root can be dangerous!). This user should have all the
          necessary permissions to get your web application working properly
          (e.g. write access on required files and directories etc)

  The following parameters are optional

    -T, --type
          Type of the application either rack or rails (default: rails)
    -E, --environment
          Environment in which you want to run the application
          (default: production)
    -A, --analytics
          Enable analytics to get detailed numbers about the run time
          performance of the application. This number gathering adds a very
          small overhead on your application
    -N, --min-workers
          Minimum number of worker processes that should run for this deployed
          application. Multiple worker instances help in processing a higher
          number of concurrent user requests simultaneously. The server would
          always ensure at least these many worker processes run for this
          application (default: 4)
    -X, --max-workers
          Maximum number of worker processes that should run for this deployed
          application. Multiple worker instances help in processing a higher
          number of concurrent user requests simultaneously. The server would
          ensure that maximum only these many worker processes run for this
          application (default: 8)

  Summary:
    Deploy (and start) a new application on the server.

  Usage:
    webroar remove APPNAME

  Arguments:
    APPNAME        Name of the application

  Summary:
    Remove the specified application from the server.

  Usage:
    webroar test [options]

  Options:
    -r, --report-dir DIR    Report directory
    -d, --debug-build       Compile the server as a debug build to output
    extremely verbose logs
    -l, --load-test         Also run the load tests

  Summary:
    Run the test suite