Ruby on Rails: Difference between revisions
mNo edit summary |
Update RoR guide with refreshed steps & screenshots |
||
| Line 1: | Line 1: | ||
= Ruby on Rails = | = Ruby on Rails = | ||
{{Caution| | {{Caution| | ||
Ruby on Rails is available on [[: | Ruby on Rails is available on [[:Morty|Morty]], [[:Tommy|Tommy]], [[:Johnny|Johnny]], or the [https://heliohost.org/vps/ VPS plans]. | ||
}} | }} | ||
= Preface = | == Preface == | ||
HelioHost is one of the few free web hosts to offer the Ruby programming language. A combination of Perl's syntax and Smalltalk's semantics, Ruby is a mature production language that remains popular. Ruby's compatibility with multiple programming paradigms allows it great versatility and makes it an easy language to learn for existing developers. | HelioHost is one of the few free web hosts to offer the Ruby programming language. A combination of Perl's syntax and Smalltalk's semantics, Ruby is a mature production language that remains popular. Ruby's compatibility with multiple programming paradigms allows it great versatility and makes it an easy language to learn for existing developers. | ||
| Line 11: | Line 11: | ||
We also offer the powerful Ruby on Rails web application framework. This framework contains all the essentials for building a web application, and greatly simplifies the task by providing libraries tailored to do almost any task. By utilizing the Model-View-Controller architectural pattern, Rails effectively separates different aspects of your web application, allowing for modular design and extensibility. | We also offer the powerful Ruby on Rails web application framework. This framework contains all the essentials for building a web application, and greatly simplifies the task by providing libraries tailored to do almost any task. By utilizing the Model-View-Controller architectural pattern, Rails effectively separates different aspects of your web application, allowing for modular design and extensibility. | ||
= How to set up Ruby on Rails = | == How to set up Ruby on Rails == | ||
= Download the example project = | === Download the example project === | ||
Download the example Ruby on Rails files from: [https:// | Download the example Ruby on Rails files from: [https://heliohost.org/downloads/ror_ruby3.2.2_rails8.0.1.tar.gz heliohost.org/downloads/ror_ruby3.2.2_rails8.0.1.tar.gz] | ||
= | === Upload the example project === | ||
Navigate to your home directory and click the '+' button to upload the tar.gz file. Locate the 'ror_ruby3.2.2_rails8.0.1.tar.gz' file that you just downloaded, and upload it to Plesk. Make sure you upload it to your home directory, not 'httpdocs'. | |||
[[File:ror_upload.png]] | [[File:ror_upload.png]] | ||
= Extract the example project files = | === Extract the example project files === | ||
Now click the filename of 'ror_ruby3.2. | Now click the filename of 'ror_ruby3.2.2_rails8.0.1.tar.gz' to extract the tar.gz file. Make sure that it is extracting the files to the '/' directory and not to 'httpdocs' or anywhere else. | ||
[[File:ror_extract.png]] | [[File:ror_extract.png]] | ||
= Edit the 'environment' file = | === Edit the 'environment' file === | ||
Click on the 'config' directory, and then click the 'environment.rb' file to edit it. You'll need to change the line that says ' | Click on the 'config' directory, and then click the 'environment.rb' file to edit it. You'll need to change the line that says 'ror.helioho.st' to your actual domain. Then save the file. | ||
[[File:ror_domain.png]] | [[File:ror_domain.png]] | ||
= Install Ruby = | === Install Ruby === | ||
Now click 'Websites and Domains' on the main left Plesk menu. | Now click 'Websites and Domains' on the main left Plesk menu. Next click the header 'Get Started' and then click 'Ruby' from the menu displayed. | ||
[[File:ror_ruby.png]] | [[File:ror_ruby.png]] | ||
= Enable Ruby = | === Enable Ruby === | ||
The test Ruby on Rails files are designed for Ruby 3.2. | The test Ruby on Rails files are designed for Ruby 3.2.2 so ensure you have 'Ruby Version' set to '3.2.2-p53'. Change the 'Application Mode' from 'production' to 'development' so you can see errors later, and wait until you see a confirmation message that says 'Information: Application mode was successfully updated'. Then click 'Enable Ruby' and wait for the confirmation message saying Ruby was enabled: | ||
[[File:ror_enable.png]] | [[File:ror_enable.png]] | ||
= Wait for Ruby Deployment = | === Wait for Ruby Deployment === | ||
{{Info|In order for the Rails application to be deployed it requires an Apache restart. Apache restarts happen every | {{Info| | ||
In order for the Rails application to be deployed it requires an Apache restart. Apache restarts happen every 2 hours. Please be patient and wait for the full 2 hours before assuming anything is broken. | |||
Toggling the 'Application Mode' between 'production' to 'development' also requires an Apache restart for the new setting to take effect. We recommend keeping this setting in 'development' mode until your application has been successfully deployed without errors. | |||
}} | |||
If everything is working it should look like this: | If everything is working it should look like this: | ||
| Line 63: | Line 61: | ||
Once you've got this basic example working we encourage you to edit the files, and create your Ruby on Rails website. Let us know if you have any questions. | Once you've got this basic example working we encourage you to edit the files, and create your Ruby on Rails website. Let us know if you have any questions. | ||
= Further Support = | == Troubleshooting == | ||
If you receive an error message that says: | |||
'Web application could not be started by the Phusion Passenger(R) application server. Please read the Passenger log file (search for the Error ID) to find the details of the error. You can also get a detailed report to appear directly on this page, but for security reasons it is only provided if Phusion Passenger(R) is run with environment set to development and/or with the friendly error pages option set to on.' | |||
This means the 'Application Mode' was not switched from 'production' to 'development'. To enable more detailed error reporting, please refer to the steps listed above to set the 'Application Mode' from 'production' to 'development'. After changing to development mode, restart your app. You will then need to wait for up to 2 hours for the next Apache restart for the new setting to take effect. We recommend leaving the 'Application Mode' as 'development' so that you can see error logs. | |||
=== Further Support === | |||
If it doesn't work, go back and check all of your steps again. If it's been more than | If it doesn't work, go back and check all of your steps again. If it's been more than a full 2 hours and it still isn't working please make a new post in the [https://helionet.org/index/forum/45-customer-service/?do=add Customer Service forum], making sure to provide your '''username''' and any '''error messages''' you are encountering. | ||
Revision as of 15:32, 17 January 2025
Ruby on Rails
Preface
HelioHost is one of the few free web hosts to offer the Ruby programming language. A combination of Perl's syntax and Smalltalk's semantics, Ruby is a mature production language that remains popular. Ruby's compatibility with multiple programming paradigms allows it great versatility and makes it an easy language to learn for existing developers.
We also offer the powerful Ruby on Rails web application framework. This framework contains all the essentials for building a web application, and greatly simplifies the task by providing libraries tailored to do almost any task. By utilizing the Model-View-Controller architectural pattern, Rails effectively separates different aspects of your web application, allowing for modular design and extensibility.
How to set up Ruby on Rails
Download the example project
Download the example Ruby on Rails files from: heliohost.org/downloads/ror_ruby3.2.2_rails8.0.1.tar.gz
Upload the example project
Navigate to your home directory and click the '+' button to upload the tar.gz file. Locate the 'ror_ruby3.2.2_rails8.0.1.tar.gz' file that you just downloaded, and upload it to Plesk. Make sure you upload it to your home directory, not 'httpdocs'.
Extract the example project files
Now click the filename of 'ror_ruby3.2.2_rails8.0.1.tar.gz' to extract the tar.gz file. Make sure that it is extracting the files to the '/' directory and not to 'httpdocs' or anywhere else.
Edit the 'environment' file
Click on the 'config' directory, and then click the 'environment.rb' file to edit it. You'll need to change the line that says 'ror.helioho.st' to your actual domain. Then save the file.
Install Ruby
Now click 'Websites and Domains' on the main left Plesk menu. Next click the header 'Get Started' and then click 'Ruby' from the menu displayed.
Enable Ruby
The test Ruby on Rails files are designed for Ruby 3.2.2 so ensure you have 'Ruby Version' set to '3.2.2-p53'. Change the 'Application Mode' from 'production' to 'development' so you can see errors later, and wait until you see a confirmation message that says 'Information: Application mode was successfully updated'. Then click 'Enable Ruby' and wait for the confirmation message saying Ruby was enabled:
Wait for Ruby Deployment
In order for the Rails application to be deployed it requires an Apache restart. Apache restarts happen every 2 hours. Please be patient and wait for the full 2 hours before assuming anything is broken.
Toggling the 'Application Mode' between 'production' to 'development' also requires an Apache restart for the new setting to take effect. We recommend keeping this setting in 'development' mode until your application has been successfully deployed without errors.
If everything is working it should look like this:
Once you've got this basic example working we encourage you to edit the files, and create your Ruby on Rails website. Let us know if you have any questions.
Troubleshooting
If you receive an error message that says:
'Web application could not be started by the Phusion Passenger(R) application server. Please read the Passenger log file (search for the Error ID) to find the details of the error. You can also get a detailed report to appear directly on this page, but for security reasons it is only provided if Phusion Passenger(R) is run with environment set to development and/or with the friendly error pages option set to on.'
This means the 'Application Mode' was not switched from 'production' to 'development'. To enable more detailed error reporting, please refer to the steps listed above to set the 'Application Mode' from 'production' to 'development'. After changing to development mode, restart your app. You will then need to wait for up to 2 hours for the next Apache restart for the new setting to take effect. We recommend leaving the 'Application Mode' as 'development' so that you can see error logs.
Further Support
If it doesn't work, go back and check all of your steps again. If it's been more than a full 2 hours and it still isn't working please make a new post in the Customer Service forum, making sure to provide your username and any error messages you are encountering.