Application Manager

Valid for version 82

Version:

82

84

90

94


Last modified: December 3, 2021

Overview

This interface allows you to deploy applications with the Phusion Passenger® application server. A Phusion Passenger server functions as a process manager, reverse proxy, and provides operations tools to its users.

Note:

Before you can view this interface or deploy an application, your hosting provider must enable several settings.

Applications

The applications table contains the following information:

  • Name — The application’s name.
  • Domain — The application’s domain.
  • Path — The file where the application’s source code resides, relative to the home directory.
  • Status — Whether the application is enabled or disabled.
    Note:
    • Enabled — This option enables the application on the webserver.
    • Disabled — This option disables the application on the webserver.
  • Actions — Use the items in this column to perform the following actions:
    • Edit — Edit the application.
    • Unregister — Unregister the application.
    • Enable Dependencies — Confirm and, if necessary, install an application’s Node.js package manager (npm) dependencies.

Create an application

You must create an application before you register it in the Application Manager interface. For example, you could perform one of the following actions:

  • Clone an existing application from GitHub with our Git Version Control interface (cPanel >> Home >> Files >> Git™ Version Control).

  • Create a new application on your server. For an example of how to do this, read our How to Create Ruby Web Applications documentation.

Warning:

Applications that you create with the following interfaces will not function with the Application Manager interface:

  • WHM’s Module Installers interface (WHM >> Home >> Security >> Module Installers).

  • cPanel’s Ruby on Rails interface (cPanel >> Home >> Software >> Ruby on Rails).

  • cPanel’s RubyGems interface (cPanel >> Home >> Software >> RubyGems).

  • WHM’s Ruby Gem installer interface (WHM >> Home >> Software >> Module Installers >> Ruby Gem Installer).

We plan to remove these interfaces in a future cPanel & WHM version.

Register an application

To register an application, perform the following steps:

  1. Click Register 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 application.

  4. Enter the application’s base URL in the Application URL text box. After you register the application, enter this URL in a web browser to access the application.

  5. Enter the filepath, relative to the home directory, for the file where your application’s source code resides in the Path text box.

  6. Click Production or Development to choose the server environment in which the application runs.

    • Click Development if you need to continue to develop your application.
    • Click Production if you wish to deploy and use your application.
  7. If you wish, add environment variables environment variables under the Environment Variables heading.

  8. Click Deploy.

Environment Variables

Warning:

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

Environment variables allow you to configure the processes that the application runs on multiple systems. The Environment Variables table contains the following information:

Column Description
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.
  • Unregister — Delete the environment variable.

For more information about environment variables, read Phusion Passenger’s Environment Variables documentation.

Add environment variables

To add an environment variable to the 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. Repeat steps 1-3 for each environment variable that you want to add.

Edit an application

To edit an application’s configuration file, perform the following steps:

  1. In the table below the Search text box, locate the application that you wish to change.

  2. In the Actions column, click Edit. A new interface will appear.

  3. Make the desired changes.

  4. Click Deploy.

Unregister an application

To unregister an application, perform the following steps:

Important:

This action deletes an application’s configuration file, but does not delete an application. Your hosting provider must manually remove it.

  1. In the table below the Search text box, locate the application that you wish to unregister.

  2. Click Unregister. A confirmation message will appear.

  3. Click Unregister to completely unregister the application. A success message will appear.

Additional Documentation