Child pages
  • Application Manager
Skip to end of metadata
Go to start of metadata

For cPanel & WHM version 66.

(Home >> Software >> Application Manager)

Overview

This interface allows you to quickly deploy and easily maintain Ruby applications on cPanel & WHM servers.

The Application Manager interface operates together with the Phusion Passenger application server. A Phusion Passenger server functions as a process manager, reverse proxy, and provides operations tools to its users. 

Important:

  • This interface only appears if your system administrator performs the following actions:
  • Your system administrator can configure your account's maximum number of Ruby applications in WHM's Modify an Account interface (Home >> Accounts >> Modify an Account).
    • If the maximum number of Ruby applications exist on your account, a warning message will display at the top of the Application Manager interface. The system will also not allow you to add another Ruby application.

The Application table

The interface lists available Ruby applications in a table below the Search text box. This table contains the following information:

ColumnDescription
NameThe Ruby application's name.
DomainThe domain for which to register the application.
PathThe Ruby application's configuration file path, relative to the user's /home directory.
StatusWhether the Ruby application is enabled or disabled.
Actions

Use the links in this column to perform the following actions:

  • Edit — Edit the Ruby application
  • Delete — Delete the Ruby application.

Add an application

To add a Ruby application, perform the following steps:

  1. Click Add Application. A new interface will appear.

  2. Enter the application's name in the Name text box.
  3. From the Domain menu, select the main domain, addon domain, or subdomain to which to deploy the Ruby application.
  4. Enter the application's base URL in the Application URL text box.

  5. Enter a filepath relative to the /home/username directory in the Path to Application text box. 

    Note:

    username represents the cPanel user's name.

  6. Select either the Production or Development  button to choose the server environment in which the Ruby application will run.
  7. If you wish, add environment variables under the Environment Variables heading.
  8. Click Save Application.

Environment Variables

Warning:

To add environment variables, your System Administrator must install the ea-apache24-mod_env RPM Apache module.

The Environment Variables table contains the following information:

ColumnDescription
Name

The environment variable's name.

Important:

An environment variable name must meet the following criteria:

  • The name can only contain letters, numbers, underscores, and dashes.
  • The name must contain 256 characters or fewer.
  • The name cannot begin with a number.
Value

The environment variable's value.

Important:

An environment variable value must contain 1024 or fewer ASCII-printable characters.

Actions

Use the links in this column to perform the following actions:

  • Edit — Edit the environment variable.
  • Delete — Delete the environment variable.

Add environment variables

To add an environment variable to the Ruby application's configuration file, perform the following steps:

  1. In the Environmental Variables section, click Add Variable.
  2. Enter the variable's name in the Environment Variable Name text box.

  3. Enter a value for the variable in the  Environment Variable Value text box and click Save.
  4. Click Save Application.

  Edit an application

To edit a Ruby application, perform the following steps:

  1. In the table below the Search text box, locate the Ruby application that you wish to change.
  2. Under the Actions column, click Edit. A new interface will appear.
  3. Make the desired changes.

  4. Click Save.

Delete an application

To delete an application, perform the following steps:

  1. In the table below the Search text box, locate the Ruby application that you wish to change.
  2. Click Delete. A confirmation message will appear.
  3. Click Continue to completely delete the Ruby application. A message of success will appear.