For cPanel & WHM version 56
(Home >> Software and Services >> Ruby on Rails)
This document describes functionality from cPanel's deprecated x3 theme. We strongly recommend that you use cPanel's current theme (Paper Lantern) instead.
- We removed the deprecated x3 theme from new installations in cPanel & WHM version 60.
- Make certain that you read the appropriate documentation for your version of cPanel & WHM.
- For more information, read our What's My Version Number documentation.
- cPanel's Paper Lantern theme does not include certain x3 theme-specific features.
- For a complete list of Paper Lantern features, read our cPanel Features List documentation.
- If you need a feature that the Paper Lantern theme does not include, submit a feature request.
This interface allows you to create and deploy a Ruby on Rails® application.
- To use this feature, your system administrators must enable it for you.
- Before you deploy a Ruby on Rails application, read the Ruby on Rails documentation.
How to create a Ruby on Rails application
After you confirm that your server uses a functional and accessible version of Ruby, you can create and deploy a Ruby on Rails environment.
Because Ruby on Rails runs on its own server, it requires the following steps to set up the environment:
Enter your application's name in the App Name text box.
To load when the server boots, select the Load on Boot? checkbox.
Enter the application path in the Application Path text box.
If you set an application path in your
public_html/directory, anyone on the web can view your source code and configuration files.
- In the Environment menu, select the type of Ruby on Rails environment that you prefer.
You can perform the following actions on applications in the Ruby on Rails Applications table:
- To redirect to an application's Rails server, click URL.
- To run an application, click Run.
- To stop an application, click Stop.
- To load an application when the server boots, select the Load on Boot? checkbox.
- To toggle an application between a production or development environment, select or deselect the Production checkbox.
- To delete an application, click the icon.
How to create a Rewrite
Because Ruby on Rails uses its own server and does not respond on the standard HTTP port number
80, you must specify the port where site visitors can access your Ruby on Rails application (for example,
- Ruby application port numbers increment automatically with every new application. If you are on a shared server, the system assigns the next available port number to your application.
- Your first application will not necessarily run on port
To configure Ruby to respond without the need for visitors to specify a port number, create a rewrite.
To configure a rewrite, perform the following steps:
- In the Create A Rewrite table, click Create Rewrite for the appropriate application
- From the menu, select the domain, subdomain, or addon domain on which you wish to run your Ruby application.
- To run the application from a new page within your domain, enter the page name that you wish to use in the available text box.
- Click Save.
You can perform the following actions in the Current Rewrites table:
- To change an application path name, enter the path name in the text box.
- To save an application rewrite, click Save.
- To delete an application rewrite, click Delete.
Additional applications and rewrites
To run multiple Ruby applications, you must configure additional ports to respond with Ruby on Rails and, if necessary, additional rewrites to disguise the port change.
- To add additional Rails applications, follow the steps in the How to create a Ruby on Rails application section.
The new application will respond on the next available port number (for example, if your first application runs on port
12001, the second may run on port
Ruby application port numbers increment automatically with every new application. If you are on a shared server, the system assigns the next available port number to your application. Also, your applications' port numbers may not be consecutive.
To configure an additional rewrite, follow the steps in the How to create a Rewrite section.
You will need to use a new domain, addon domain, subdomain, or page (for example,
example.com/RubyApplication) for the rewrite.
You cannot configure two Ruby applications to respond on the same domain, subdomain, addon domain, or page.
Note for resellers and web hosts
You can limit the number of Rails applications that your customers can install in WHM's Modify an Account interface (Home >> Account Functions >> Modify An Account). Perform the following steps to set the maximum number of Rails applications:
- Click the domain name that you wish to limit.
- In the Max Mongrel instances (Ruby on Rails) text box, enter the maximum number of Rails applications that you wish to allow your customers to install.
- Click Save.