Rails¶

The OpenLiteSpeed Rails One-Click app automatically installs performance web server OpenLiteSpeed, Ruby and Rails. This image is still in beta! OpenLiteSpeed features easy setup for SSL and RewriteRules. OLS is flexible and also supports Python and NodeJS apps, as well as CMSs like WordPress.

Quick Start¶

Step 1.¶

Step 2.¶

An interactive script that runs will prompt you for your domain or subdomain:

Please input a valid domain:
Please verify it is correct. [y/N]

Enter your root domain only. The system will automatically add the www subdomain as well.

If your domain is already pointed to this server, you will have the option of automatically applying Let's Encrypt SSL. Enter y and your email address to complete the process:

Do you wish to issue a Let's encrypt certificate for this domain? [y/N]
Please enter your E-mail:
Please verify it is correct: [y/N]

Once finished, you should see Certificate has been successfully installed...

You can force HTTPS rules to be applied:

Do you wish to force HTTPS rewrite rule for this domain? [y/N]

Complete the process by pressing Y:

Do you wish to update the system which include the web server? [Y/n]

You should not be prompted to initiate this setup again.

Step 3.¶

Visit the default script by entering http://Server_IP on your browser and you should see Yay! You’re on Rails! default page.

Start editing the Rails project here

/usr/local/lsws/Example/html/demo

Optional but recommended:¶

Update system software.

sudo apt update && sudo apt upgrade -y

Your system is installed and ready to use!

Components¶

The OpenLiteSpeed Rails 1-Click Droplet installs several packages and performs other actions on your system.

Package Installation¶

Other Actions¶

• Enables the UFW firewall to allow only SSH (port 22), HTTP (port 80) and HTTPS (port 443) access.
• Runs rails generate controller welcome index command to create welcome files and route
• Adds get "/", to: "rails/welcome#index" to config/routes.rb file
• Adds a / app context from OpenLiteSpeed > Example Virtual Host so web server can handle the traffic for Rails

How to Access the Installed Software¶

From a terminal on your local computer, connect to the server as root, like so:

ssh root@192.0.2.0

Be sure to substitute the server’s public IP address for 192.0.2.0.

Web Server Control Panel Access¶

Get the WebAdmin admin password:

cat .litespeed_password

cat /home/ubuntu/.litespeed_password

cat /home/ubuntu/.litespeed_password

Visit https://use_your_droplet_ip:7080 to access WebAdmin in a browser.

By default, WebAdmin uses port 7080. To allow access to 7080 from your IP(e.g. 192.0.2.0):

ufw allow from 192.0.2.0 to any port 7080

ufw allow 7080

We suggest turning this port off once you've finished setup:

ufw delete allow 7080

Optional Setup¶

Enable HTTPS¶

Setting up an SSL certificate enables HTTPS on the web server, which secures the traffic between the server and the clients connecting to it. Certbot is a free and automated way to set up SSL certificates on a server.

Step 1. Register Domain¶

To use Certbot, you’ll need a registered domain name and DNS records:

• An A record from the domain (e.g., example.com) to the server’s IP address

• An A record from the domain prefaced with www (e.g., www.example.com) to the server’s IP address.

Step 2. Add Domain to Listener¶

Navigate to OpenLiteSpeed WebAdmin Console > Listeners, and add Your Domain to HTTP/HTTPS.

Step 3. Certbot¶

Once the DNS records are set up, you can generate the SSL certificate. Be sure to substitute the correct domain name in the following command:

certbot certonly --webroot -w /var/www/html/ -d example.com -d www.example.com

Step 4. Set SSL for HTTPS¶

Navigate to OpenLiteSpeed WebAdmin Console > Listeners > SSL, and edit the following three items:

• Private Key File = /etc/letsencrypt/live/example.com/privkey.pem
• Certificate File = /etc/letsencrypt/live/example.com/fullchain.pem
• Chained Certificate = Yes

Save and perform a Graceful Restart.

Now your server should support TLS1.1, TLS 1.2, and TLS 1.3.

Step 5. Redirect HTTP to HTTPS¶

HTTPS traffic on port 443 is already allowed through the firewall. After you set up HTTPS, you can optionally rewrite all HTTP traffic to HTTPS.

Add the following rules to OpenLiteSpeed WebAdmin Console > Virtual Hosts > Rewrite > Rewrite Rules

RewriteCond %{SERVER_PORT} 80
RewriteRule ^(.*)$ https://example.com/$1 [R,L]

Method for Uploading Files¶

You can serve files from the web server by adding them to the web root using SFTP or other tools.

Frequently Asked Questions¶

How do I Reset my Web Server WebAdmin Password?¶

If you forget your password, you may run the following command to reset it:

/usr/local/lsws/admin/misc/admpass.sh

It will ask for the WebAdmin username, which should be admin. Then, enter your new password.

How do I Create Additional Virtual Hosts?¶

wget https://raw.githubusercontent.com/litespeedtech/ls-cloud-image/master/Setup/vhsetup.sh
chmod +x vhsetup.sh
bash vhsetup.sh

/bin/bash <( curl -sk https://raw.githubusercontent.com/litespeedtech/ls-cloud-image/master/Setup/vhsetup.sh )

wget https://raw.githubusercontent.com/litespeedtech/ls-cloud-image/master/Setup/vhsetup.sh
chmod +x vhsetup.sh
bash vhsetup.sh -d www.example.com -le admin@example.com -f -w

/bin/bash <( curl -sk https://raw.githubusercontent.com/litespeedtech/ls-cloud-image/master/Setup/vhsetup.sh ) -d www.example.com -le admin@example.com -f -w

How do I upgrade OpenLiteSpeed to latest stable version?¶

OpenLiteSpeed was installed from the LiteSpeed repository, so you can simply use the system update to update OpenLiteSpeed to the latest stable version.

$ sudo apt update && sudo apt upgrade openlitespeed -y

How do I Fix Blocked Host Error?¶

There are two ways to fix a blocked host error: whitelist the hostname, or disable the check. (As seen on StackOverflow.)

Whitelist the Hostname¶

Add the following pattern to the config/environments/development.rb file (replace hostname with the hostname you wish to allow):

config.hosts << "hostname"

Disable the Check¶

Disable the check for all environments by adding the following pattern to the config/application.rb file:

config.hosts = nil

How do I Run Rails Server?¶

Since the image comes with the OpenLiteSpeed web server already, we did not install an extra webpacker package. You can do so with the following steps:

1. Install yarn package

   curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
   echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
   sudo apt update
   sudo apt install yarn -y
   

2. Install webpacker package

   rails webpacker:install
   

3. Allow firewall port 3000

   ufw allow 3000
   

4. Start built-in web server

   rails server -b 0.0.0.0
   

How do I upgrade to LiteSpeed Enterprise?¶

This script will:

1. Generate LiteSpeed Enterprise config file from OpenLiteSpeed config

2. Backup OpenLiteSpeed config and uninstall OpenLiteSpeed

3. Install LiteSpeed and load the config file

/bin/bash <( curl -sk https://raw.githubusercontent.com/litespeedtech/ls-cloud-image/master/Setup/ols2ent-v2.sh )

How to cache the site with LSCache Rules¶

Visit LSCache Without a Plugin doc

We can put following example rules to the OLS Web Admin > Virtual Hosts > Context > App Server context > Rewrite Rules:

CacheLookup on
RewriteCond %{REQUEST_URI} !/admin/
RewriteRule .* - [E=cache-control:max-age=120]

And with that, you have just enabled caching on your site. All pages that are not in the admin subdirectory, will be cached publicly for two minutes.

API Creation¶