Skip to content

Commit 02dfc1f

Browse files
hmorris3293Magda Sulik
andauthored
[update] Ruby on Rails & Rocketchat Marketplace docs (#7282)
* update ruby on rails marketplace doc * update rocket and rubyonrails * editorial review --------- Co-authored-by: Magda Sulik <[email protected]>
1 parent 91594fc commit 02dfc1f

File tree

7 files changed

+63
-99
lines changed

7 files changed

+63
-99
lines changed

docs/marketplace-docs/guides/rocketchat/index.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@
22
title: "Deploy Rocket.Chat through the Linode Marketplace"
33
description: "Deploy Rocket.Chat on a Linode Compute Instance. This provides you with a self-hosted open source chat application (Slack alternative)."
44
published: 2021-11-12
5-
modified: 2022-03-08
5+
modified: 2025-06-03
66
keywords: ['rocketchat','chat','slack','communication']
77
tags: ["marketplace", "linode platform", "cloud manager"]
88
external_resources:
99
- '[Rocket.Chat](https://rocket.chat/)'
10+
- '[Rocket.Chat documentation](https://docs.rocket.chat/guides/user-guides)'
1011
aliases: ['/products/tools/marketplace/guides/rocketchat/','/guides/deploying-rocketchat-marketplace-app/','/guides/rocketchat-marketplace-app/']
1112
authors: ["Akamai"]
1213
contributors: ["Akamai"]
@@ -29,7 +30,7 @@ Rocket.Chat is a self-hosted open source chat application that can be used as an
2930

3031
## Configuration Options
3132

32-
- **Supported distributions:** Ubuntu 20.04 LTS
33+
- **Supported distributions:** Ubuntu 24.04 LTS
3334
- **Recommended plan:** All plan types and sizes can be used.
3435

3536
### Rocket.Chat Options
@@ -41,19 +42,33 @@ Rocket.Chat is a self-hosted open source chat application that can be used as an
4142

4243
{{% content "marketplace-special-character-limitations-shortguide" %}}
4344

45+
### Obtain the Credentials
46+
47+
Once the app is deployed, you need to obtain the credentials from the server.
48+
49+
To obtain the credentials:
50+
51+
1. Log in to your new Compute Instance using one of the methods below:
52+
53+
- **Lish Console**: Log in to Cloud Manager, click the **Linodes** link in the left menu, and select the Compute Instance you just deployed. Click **Launch LISH Console**. Log in as the `root` user. To learn more, see [Using the Lish Console](/docs/products/compute/compute-instances/guides/lish/).
54+
- **SSH**: Log in to your Compute Instance over SSH using the `root` user. To learn how, see [Connecting to a Remote Server Over SSH](/docs/guides/connect-to-server-over-ssh/).
55+
56+
1. Run the following command to access the credentials file:
57+
58+
```command
59+
cat /home/$USERNAME/.credentials
60+
```
61+
62+
This returns passwords that were automatically generated when the instance was deployed. Save them. Once saved, you can safely delete the file.
63+
4464
## Getting Started after Deployment
4565

4666
### Accessing the Rocket.Chat App
4767

4868
1. Open a browser and navigate to the domain you created in the beginning of your deployment. You can also use your Compute Instance's rDNS, which will appear like `203-0-113-0.ip.linodeusercontent.com`. See the [Managing IP Addresses](/docs/products/compute/compute-instances/guides/manage-ip-addresses/) guide for information on viewing and setting the rDNS value.
4969
50-
1. From there, Rocket.Chat prompts you to fill out multiple forms to get your instance created and ready to use:
51-
52-
![Rocket.Chat Step 1](rocketchat-setup.png)
53-
![Rocket.Chat Step 2](rocketchat-setup2.png)
54-
![Rocket.Chat Step 3](rocketchat-setup3.png)
55-
![Rocket.Chat Step 4](rocketchat-setup4.png)
70+
1. Enter your credentials which can be found in the credentials file on the server.
5671
57-
Now that you’ve gone through the setup and accessed your Rocket.Chat instance, check out [the official Rocket.Chat documentation](https://docs.rocket.chat/guides/user-guides) to learn how to further use your Rocket.Chat instance.
72+
Now that you’ve accessed your Rocket.Chat instance, check out [the official Rocket.Chat documentation](https://docs.rocket.chat/guides/user-guides) to learn how to use the instance.
5873
5974
{{% content "marketplace-update-note-shortguide" %}}
-82.8 KB
Binary file not shown.
-78.4 KB
Binary file not shown.
-72.8 KB
Binary file not shown.
-114 KB
Binary file not shown.

docs/marketplace-docs/guides/ruby-on-rails/index.md

Lines changed: 39 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Deploy Ruby on Rails through the Linode Marketplace"
33
description: "This guide provides you with installation and configuration instructions for deploying Ruby on Rails using the Lindoe One-Click Apps Marketplace."
44
published: 2020-03-11
5-
modified: 2022-03-08
5+
modified: 2025-06-03
66
keywords: ['ruby on rails','marketplace', 'marketplace apps']
77
tags: ["ruby","linode platform","marketplace","cloud-manager"]
88
image: RubyonRails_oneclickapps.png
@@ -15,7 +15,7 @@ authors: ["Akamai"]
1515
contributors: ["Akamai"]
1616
license: '[CC BY-ND 4.0](https://creativecommons.org/licenses/by-nd/4.0)'
1717
marketplace_app_id: 609048
18-
marketplace_app_name: "Roby on Rails"
18+
marketplace_app_name: "Ruby on Rails"
1919
---
2020

2121
[Ruby on Rails](http://rubyonrails.org/) is a server-side web application framework that allows web designers and developers to implement dynamic, fully featured web applications.
@@ -27,123 +27,72 @@ marketplace_app_name: "Roby on Rails"
2727
{{% content "marketplace-verify-standard-shortguide" %}}
2828

2929
{{< note >}}
30-
**Estimated deployment time:** Ruby on Rails should be fully installed within 2-5 minutes after the Compute Instance has finished provisioning.
30+
**Estimated deployment time:** Ruby on Rails should be fully installed within 5-10 minutes after the Compute Instance has finished provisioning.
3131
{{< /note >}}
3232

3333
## Configuration Options
3434

35-
- **Supported distributions:** Ubuntu 20.04 LTS
36-
- **Recommended minimum plan:** All plan types and sizes can be used.
35+
- **Supported distributions:** Ubuntu 24.04 LTS
36+
- **Recommended minimum plan:** For best results, 4GB Dedicated CPU or Shared Compute instance for Ruby on Rails.
3737

3838
### Ruby on Rails Options
3939

40-
- **Rails Application name** *(required)*: The name for your rails application.
40+
- **Rails Application name** *(required)*: Enter the name for your rails application.
41+
- **Email address** *(required)*: Enter the email address to use for generating the SSL certificates.
4142

42-
## Getting Started after Deployment
43-
44-
### Access Ruby on Rails
45-
46-
After Ruby on Rails has finished installing, you will be able to access Ruby on Rails from the console via ssh with your Linode's IPv4 address:
47-
48-
1. [SSH into your Linode](/docs/products/compute/compute-instances/guides/set-up-and-secure/#connect-to-the-instance) and [create a limited user account](/docs/products/compute/compute-instances/guides/set-up-and-secure/#add-a-limited-user-account).
49-
50-
1. Log out and log back in as your limited user account.
43+
{{% content "marketplace-required-limited-user-fields-shortguide" %}}
5144

52-
1. Update your server:
45+
{{% content "marketplace-custom-domain-fields-shortguide" %}}
5346

54-
sudo apt-get update && apt-get upgrade
47+
{{% content "marketplace-special-character-limitations-shortguide" %}}
5548

56-
1. Ruby comes with some pre-made scripts to get you started. One of these is a blog. To begin with the blog example, use the following command:
49+
### Obtain the Credentials
5750

58-
rails new blog
51+
Once the app is deployed, you need to obtain the credentials from the server.
5952

60-
This creates a new Rails application called Blog in the `blog` directory.
53+
To obtain the credentials:
6154

62-
1. Move into the `blog` directory:
55+
1. Log in to your new Compute Instance using one of the methods below:
6356

64-
cd blog
57+
- **Lish Console**: Log in to Cloud Manager, click the **Linodes** link in the left menu, and select the Compute Instance you just deployed. Click **Launch LISH Console**. Log in as the `root` user. To learn more, see [Using the Lish Console](/docs/products/compute/compute-instances/guides/lish/).
58+
- **SSH**: Log in to your Compute Instance over SSH using the `root` user. To learn how, see [Connecting to a Remote Server Over SSH](/docs/guides/connect-to-server-over-ssh/).
6559

66-
1. Start the built in server with the following command, replacing the IP address with your Linode's IP address:
60+
1. Run the following command to access the credentials file:
6761

68-
rails server --binding=198.51.100.0
69-
70-
```output
71-
Warning: Running `gem pristine --all` to regenerate your installed gemspecs (and deleting then reinstalling your bundle if you use bundle --path) will improve the startup performance of Spring.
72-
=> Booting WEBrick
73-
=> Rails 4.2.7.1 application starting in development on http://198.51.100.0:3000
74-
=> Run `rails server -h` for more startup options
75-
=> Ctrl-C to shutdown server
76-
[2020-03-11 14:17:16] INFO WEBrick 1.3.1
77-
[2020-03-11 14:17:16] INFO ruby 2.3.3 (2016-11-21) [x86_64-linux-gnu]
78-
[2020-03-11 14:17:16] INFO WEBrick::HTTPServer#start: pid=3089 port=3000
62+
```command
63+
cat /home/$USERNAME/.credentials
7964
```
8065

81-
1. You can visit your application by visiting the address in the browser.
82-
83-
![Rails Welcome Page](rails-welcome-page.png "Rails Welcome Page")
84-
85-
1. Exit the server process with **Ctrl+C**.
86-
87-
## Create a Controller and View
88-
89-
A controller will receive requests which are then routed and served by various actions. A view displays information.
66+
This returns passwords that were automatically generated when the instance was deployed. Save them. Once saved, you can safely delete the file.
9067

91-
1. Create a controller called `Welcome` and an action called `index`:
92-
93-
rails generate controller Welcome index
94-
95-
```output
96-
create app/controllers/welcome_controller.rb
97-
route get 'welcome/index'
98-
invoke erb
99-
create app/views/welcome
100-
create app/views/welcome/index.html.erb
101-
invoke test_unit
102-
create test/controllers/welcome_controller_test.rb
103-
invoke helper
104-
create app/helpers/welcome_helper.rb
105-
invoke test_unit
106-
invoke assets
107-
invoke coffee
108-
create app/assets/javascripts/welcome.coffee
109-
invoke scss
110-
create app/assets/stylesheets/welcome.scss
111-
```
112-
113-
1. With the text editor of your choice, edit the file `app/views/welcome/index.html.erb` and replace the contents with the following:
114-
115-
```file {title="app/views/welcome/index.html.erb" lang="html"}
116-
<h1>Hello, World! This is Ruby on Rails!</h1>
117-
```
118-
119-
1. Tell Rails where to find the document root. Edit the file `config/routes.rb`, find and uncomment the line root as shown:
68+
## Getting Started after Deployment
69+
### Access Ruby on Rails
12070

121-
```file {title="config/routes" lang="conf"}
122-
Rails.application.routes.draw do
123-
get 'welcome/index'
71+
The Ruby on Rails Marketplace App is running [Nginx](https://www.nginx.com/), [Ruby](https://www.ruby-lang.org/en/), [Rails](https://rubyonrails.org/), [Puma](https://github.com/puma/puma), and [Mise](https://github.com/jdx/mise). Once deployed, a sample page should be running on your FQDN (if applicable) or the Compute Instance's Reverse DNS address.
12472
125-
...
73+
### Accessing the Ruby on Rails App through the Command Line
12674
127-
root 'welcome#index'
75+
The Ruby on Rails sample application can be found in the `/var/www/$APPNAME` directory.
12876
129-
...
130-
end
131-
```
77+
1. Log in to your Compute Instance via [SSH](/docs/guides/connect-to-server-over-ssh/) or [Lish](/docs/products/compute/compute-instances/guides/lish/).
13278
133-
1. Start the server again:
79+
1. Go to the directory in which the application is stored, by running the following command:
13480
135-
rails server --binding=198.51.100.0
81+
cd /var/www/$APPNAME
13682
137-
You should see your new welcome page in the web browser.
13883
139-
For more information on setting up a more substantial application, refer to the [Ruby on Rails Getting Started Guide](https://guides.rubyonrails.org/getting_started.html).
84+
### Viewing the Ruby on Rails App through a Web Browser
14085
141-
## Next Steps
86+
Open your web browser and navigate to `https://[domain]/`, where *[domain]* can be replaced with the custom domain you entered during deployment or your Compute Instance's rDNS domain (such as `192-0-2-1.ip.linodeusercontent.com`). See the [Managing IP Addresses](/docs/products/compute/compute-instances/guides/manage-ip-addresses/) guide for information on viewing rDNS.
14287

143-
{{% content "marketplace-update-note-shortguide" %}}
88+
## Software Included
14489

145-
For more on Ruby on Rails, checkout the following guides:
90+
| **Software** | **Description** |
91+
|:--------------|:------------|
92+
| **Ruby** | Object-Oriented programming language |
93+
| **Rails** | Web application framework |
94+
| **NGINX** | Web server and reverse proxy |
95+
| **Puma** | Web server specifically designed to run Ruby/Rails applications |
96+
| **Mise** | Modern version manager |
14697

147-
- [Ruby on Rails with NGINX on Debian](/docs/guides/ruby-on-rails-nginx-debian/)
148-
- [Ruby on Rails with Apache on Debian](/docs/guides/ruby-on-rails-apache-debian/)
149-
- [Use Unicorn and NGINX to Configure Ruby on Rails Applications on Ubuntu](/docs/guides/use-unicorn-and-nginx-on-ubuntu-18-04/)
98+
{{% content "marketplace-update-note-shortguide" %}}
-84 KB
Binary file not shown.

0 commit comments

Comments
 (0)