Top Level Namespace

Defined Under Namespace

Modules: Webroar Classes: CheckUser, CommandRunner, Help, Installer, WebroarCommand

Constant Summary collapse

WEBROAR_TEST_DIR = WebROaR - Ruby Application Server - webroar.in/ Copyright © 2009 Goonj LLC This file is part of WebROaR. WebROaR is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. WebROaR is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with WebROaR. If not, see <www.gnu.org/licenses/>.

File.expand_path(File.join(WEBROAR_ROOT, 'test', 'unit'))

WEBROAR_BIN_DIR = WEBROAR_RUBY_LIB_DIR = File.expand_path(File.join(WEBROAR_ROOT, ‘src’, ‘ruby_lib’))

File.expand_path(File.join(WEBROAR_ROOT, 'bin'))

ADMIN_PANEL_DIR =

File.join(WEBROAR_ROOT, 'src', 'admin_panel')

ADMIN_PANEL_LIB_DIR =

File.join(ADMIN_PANEL_DIR, 'lib')

RAILS_ROOT =

ADMIN_PANEL_DIR

GEM_BIN_DIR =

File.expand_path(File.join(WEBROAR_ROOT,'..','..','bin'))

USR_BIN_DIR =

File.join('','usr','bin')

WEBROAR_LOG_FILE =

File.join('','var','log','webroar','webroar.log')

PIDFILE =

"/var/run/webroar.pid"

TESTFILE =

"/etc/profile"

MESSAGE_DEPLOYMENT =

"This command needs to be run as root. Please try again using 'sudo'.".freeze

HELP =

%{
  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
}

HELP_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'.
}

HELP_INSTALL =

%{
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 linking 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
}

HELP_UNINSTALL =

%{
Usage:
  webroar uninstall

Summary:
  Uninstall the server
}

HELP_CLEAR =

%{
Usage:
  webroar clear

Summary:
  Clear the log files

Description:
  Clear the log files from '/var/log/webroar' directory.
}

HELP_START =

%{
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.
}

HELP_STOP =

%{
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.
}

HELP_RESTART =

%{
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.
}

HELP_TEST =

%{
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
}

HELP_REMOVE =

%{
  Usage:
    webroar remove APPNAME

  Arguments:
    APPNAME        Name of the application

  Summary:
    Remove the specified application from the server.
}

HELP_ADD =

%{
  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.
}

ADMIN_PANEL_ROOT = WebROaR - Ruby Application Server - webroar.in/ Copyright © 2009 Goonj LLC This file is part of WebROaR. WebROaR is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. WebROaR is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with WebROaR. If not, see <www.gnu.org/licenses/>.

File.join(WEBROAR_ROOT, 'src', 'admin_panel').freeze