diff --git a/docs/marketplace-docs/guides/rocketchat/index.md b/docs/marketplace-docs/guides/rocketchat/index.md index 886746ab18d..b66b6a99733 100644 --- a/docs/marketplace-docs/guides/rocketchat/index.md +++ b/docs/marketplace-docs/guides/rocketchat/index.md @@ -2,11 +2,12 @@ title: "Deploy Rocket.Chat through the Linode Marketplace" description: "Deploy Rocket.Chat on a Linode Compute Instance. This provides you with a self-hosted open source chat application (Slack alternative)." published: 2021-11-12 -modified: 2022-03-08 +modified: 2025-06-03 keywords: ['rocketchat','chat','slack','communication'] tags: ["marketplace", "linode platform", "cloud manager"] external_resources: - '[Rocket.Chat](https://rocket.chat/)' +- '[Rocket.Chat documentation](https://docs.rocket.chat/guides/user-guides)' aliases: ['/products/tools/marketplace/guides/rocketchat/','/guides/deploying-rocketchat-marketplace-app/','/guides/rocketchat-marketplace-app/'] authors: ["Akamai"] contributors: ["Akamai"] @@ -29,7 +30,7 @@ Rocket.Chat is a self-hosted open source chat application that can be used as an ## Configuration Options -- **Supported distributions:** Ubuntu 20.04 LTS +- **Supported distributions:** Ubuntu 24.04 LTS - **Recommended plan:** All plan types and sizes can be used. ### Rocket.Chat Options @@ -41,19 +42,33 @@ Rocket.Chat is a self-hosted open source chat application that can be used as an {{% content "marketplace-special-character-limitations-shortguide" %}} +### Obtain the Credentials + +Once the app is deployed, you need to obtain the credentials from the server. + +To obtain the credentials: + +1. Log in to your new Compute Instance using one of the methods below: + + - **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/). + - **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/). + +1. Run the following command to access the credentials file: + + ```command + cat /home/$USERNAME/.credentials + ``` + +This returns passwords that were automatically generated when the instance was deployed. Save them. Once saved, you can safely delete the file. + ## Getting Started after Deployment ### Accessing the Rocket.Chat App 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. -1. From there, Rocket.Chat prompts you to fill out multiple forms to get your instance created and ready to use: - - ![Rocket.Chat Step 1](rocketchat-setup.png) - ![Rocket.Chat Step 2](rocketchat-setup2.png) - ![Rocket.Chat Step 3](rocketchat-setup3.png) - ![Rocket.Chat Step 4](rocketchat-setup4.png) +1. Enter your credentials which can be found in the credentials file on the server. -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. +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. {{% content "marketplace-update-note-shortguide" %}} \ No newline at end of file diff --git a/docs/marketplace-docs/guides/rocketchat/rocketchat-setup.png b/docs/marketplace-docs/guides/rocketchat/rocketchat-setup.png deleted file mode 100644 index 238aa0f6b99..00000000000 Binary files a/docs/marketplace-docs/guides/rocketchat/rocketchat-setup.png and /dev/null differ diff --git a/docs/marketplace-docs/guides/rocketchat/rocketchat-setup2.png b/docs/marketplace-docs/guides/rocketchat/rocketchat-setup2.png deleted file mode 100644 index ccbfcdccb01..00000000000 Binary files a/docs/marketplace-docs/guides/rocketchat/rocketchat-setup2.png and /dev/null differ diff --git a/docs/marketplace-docs/guides/rocketchat/rocketchat-setup3.png b/docs/marketplace-docs/guides/rocketchat/rocketchat-setup3.png deleted file mode 100644 index 3557236e426..00000000000 Binary files a/docs/marketplace-docs/guides/rocketchat/rocketchat-setup3.png and /dev/null differ diff --git a/docs/marketplace-docs/guides/rocketchat/rocketchat-setup4.png b/docs/marketplace-docs/guides/rocketchat/rocketchat-setup4.png deleted file mode 100644 index ce72f4ec8f4..00000000000 Binary files a/docs/marketplace-docs/guides/rocketchat/rocketchat-setup4.png and /dev/null differ diff --git a/docs/marketplace-docs/guides/ruby-on-rails/index.md b/docs/marketplace-docs/guides/ruby-on-rails/index.md index d0cd920030e..0dacef79aa4 100644 --- a/docs/marketplace-docs/guides/ruby-on-rails/index.md +++ b/docs/marketplace-docs/guides/ruby-on-rails/index.md @@ -2,7 +2,7 @@ title: "Deploy Ruby on Rails through the Linode Marketplace" description: "This guide provides you with installation and configuration instructions for deploying Ruby on Rails using the Lindoe One-Click Apps Marketplace." published: 2020-03-11 -modified: 2022-03-08 +modified: 2025-06-03 keywords: ['ruby on rails','marketplace', 'marketplace apps'] tags: ["ruby","linode platform","marketplace","cloud-manager"] image: RubyonRails_oneclickapps.png @@ -15,7 +15,7 @@ authors: ["Akamai"] contributors: ["Akamai"] license: '[CC BY-ND 4.0](https://creativecommons.org/licenses/by-nd/4.0)' marketplace_app_id: 609048 -marketplace_app_name: "Roby on Rails" +marketplace_app_name: "Ruby on Rails" --- [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" {{% content "marketplace-verify-standard-shortguide" %}} {{< note >}} -**Estimated deployment time:** Ruby on Rails should be fully installed within 2-5 minutes after the Compute Instance has finished provisioning. +**Estimated deployment time:** Ruby on Rails should be fully installed within 5-10 minutes after the Compute Instance has finished provisioning. {{< /note >}} ## Configuration Options -- **Supported distributions:** Ubuntu 20.04 LTS -- **Recommended minimum plan:** All plan types and sizes can be used. +- **Supported distributions:** Ubuntu 24.04 LTS +- **Recommended minimum plan:** For best results, 4GB Dedicated CPU or Shared Compute instance for Ruby on Rails. ### Ruby on Rails Options -- **Rails Application name** *(required)*: The name for your rails application. +- **Rails Application name** *(required)*: Enter the name for your rails application. +- **Email address** *(required)*: Enter the email address to use for generating the SSL certificates. -## Getting Started after Deployment - -### Access Ruby on Rails - -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: - -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). - -1. Log out and log back in as your limited user account. +{{% content "marketplace-required-limited-user-fields-shortguide" %}} -1. Update your server: +{{% content "marketplace-custom-domain-fields-shortguide" %}} - sudo apt-get update && apt-get upgrade +{{% content "marketplace-special-character-limitations-shortguide" %}} -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: +### Obtain the Credentials - rails new blog +Once the app is deployed, you need to obtain the credentials from the server. - This creates a new Rails application called Blog in the `blog` directory. +To obtain the credentials: -1. Move into the `blog` directory: +1. Log in to your new Compute Instance using one of the methods below: - cd blog + - **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/). + - **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/). -1. Start the built in server with the following command, replacing the IP address with your Linode's IP address: +1. Run the following command to access the credentials file: - rails server --binding=198.51.100.0 - - ```output - 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. - => Booting WEBrick - => Rails 4.2.7.1 application starting in development on http://198.51.100.0:3000 - => Run `rails server -h` for more startup options - => Ctrl-C to shutdown server - [2020-03-11 14:17:16] INFO WEBrick 1.3.1 - [2020-03-11 14:17:16] INFO ruby 2.3.3 (2016-11-21) [x86_64-linux-gnu] - [2020-03-11 14:17:16] INFO WEBrick::HTTPServer#start: pid=3089 port=3000 + ```command + cat /home/$USERNAME/.credentials ``` -1. You can visit your application by visiting the address in the browser. - - ![Rails Welcome Page](rails-welcome-page.png "Rails Welcome Page") - -1. Exit the server process with **Ctrl+C**. - -## Create a Controller and View - -A controller will receive requests which are then routed and served by various actions. A view displays information. +This returns passwords that were automatically generated when the instance was deployed. Save them. Once saved, you can safely delete the file. -1. Create a controller called `Welcome` and an action called `index`: - - rails generate controller Welcome index - - ```output - create app/controllers/welcome_controller.rb - route get 'welcome/index' - invoke erb - create app/views/welcome - create app/views/welcome/index.html.erb - invoke test_unit - create test/controllers/welcome_controller_test.rb - invoke helper - create app/helpers/welcome_helper.rb - invoke test_unit - invoke assets - invoke coffee - create app/assets/javascripts/welcome.coffee - invoke scss - create app/assets/stylesheets/welcome.scss - ``` - -1. With the text editor of your choice, edit the file `app/views/welcome/index.html.erb` and replace the contents with the following: - - ```file {title="app/views/welcome/index.html.erb" lang="html"} -

Hello, World! This is Ruby on Rails!

- ``` - -1. Tell Rails where to find the document root. Edit the file `config/routes.rb`, find and uncomment the line root as shown: +## Getting Started after Deployment +### Access Ruby on Rails - ```file {title="config/routes" lang="conf"} - Rails.application.routes.draw do - get 'welcome/index' +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. - ... +### Accessing the Ruby on Rails App through the Command Line - root 'welcome#index' +The Ruby on Rails sample application can be found in the `/var/www/$APPNAME` directory. - ... - end - ``` +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/). -1. Start the server again: +1. Go to the directory in which the application is stored, by running the following command: - rails server --binding=198.51.100.0 + cd /var/www/$APPNAME - You should see your new welcome page in the web browser. -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). +### Viewing the Ruby on Rails App through a Web Browser -## Next Steps +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. -{{% content "marketplace-update-note-shortguide" %}} +## Software Included -For more on Ruby on Rails, checkout the following guides: +| **Software** | **Description** | +|:--------------|:------------| +| **Ruby** | Object-Oriented programming language | +| **Rails** | Web application framework | +| **NGINX** | Web server and reverse proxy | +| **Puma** | Web server specifically designed to run Ruby/Rails applications | +| **Mise** | Modern version manager | -- [Ruby on Rails with NGINX on Debian](/docs/guides/ruby-on-rails-nginx-debian/) -- [Ruby on Rails with Apache on Debian](/docs/guides/ruby-on-rails-apache-debian/) -- [Use Unicorn and NGINX to Configure Ruby on Rails Applications on Ubuntu](/docs/guides/use-unicorn-and-nginx-on-ubuntu-18-04/) +{{% content "marketplace-update-note-shortguide" %}} \ No newline at end of file diff --git a/docs/marketplace-docs/guides/ruby-on-rails/rails-welcome-page.png b/docs/marketplace-docs/guides/ruby-on-rails/rails-welcome-page.png deleted file mode 100644 index d6e00795da2..00000000000 Binary files a/docs/marketplace-docs/guides/ruby-on-rails/rails-welcome-page.png and /dev/null differ