Skip to content

Commit

Permalink
[update] January Marketplace doc updates (#7178)
Browse files Browse the repository at this point in the history
* jan marketplace distro& instruction

* rabbitmq lts add

* review for January Marketplace release

* review for January Marketplace release

---------

Co-authored-by: Magda Sulik <[email protected]>
  • Loading branch information
hmorris3293 and Magda Sulik authored Jan 28, 2025
1 parent e0da4fe commit a47acf0
Show file tree
Hide file tree
Showing 6 changed files with 106 additions and 57 deletions.
51 changes: 30 additions & 21 deletions docs/marketplace-docs/guides/drupal/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,35 +29,49 @@ In addition to the core infrastructure, there are a number of freely available D

## Configuration Options

- **Supported distributions:** Ubuntu 22.04 LTS
- **Supported distributions:** Ubuntu 24.04 LTS
- **Recommended minimum plan:** All plan types and sizes can be used.

### Drupal Options

- **Database Root Password** *(required)*: Password for your Drupal site's MariaDB database `root` user.
- **Database User Password** *(required)*: Password for your Drupal site's MariaDB database `drupal` user.
- **Email address** *(required)*: Email address to use for generating the SSL certificates.
- **Drupal Site Name** *(required)*: Drupal site name.
- **Drupal Site Email** *(required)*: Drupal site email for system notifications.
- **Drupal Account Email** *(required)*: Drupal account email address for an admin user.
- **Drupal User Name** *(required)*: Admin username for the Drupal site.

{{% content "marketplace-required-limited-user-fields-shortguide" %}}

{{% content "marketplace-custom-domain-fields-shortguide" %}}

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

## Getting Started after Deployment
### Obtain the Credentials

### Access your Drupal Site
Once the app is deployed, you need to obtain the credentials from the server.

1. Open a web browser and navigate to the domain you entered when creating the instance: `https://domain.tld`. If you did not enter a domain, use your Compute Instance's default rDNS domain (`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 the rDNS value. Ensure that you are securely accessing the website by prefixing `https` to the URL.
To obtain the credentials:

1. The initial configuration and installation screen for your Drupal site should be displayed. Follow the prompts for the **Choose language**, **Choose profile**, and **Verify requirements** screens, selecting the appropriate configuration values for your Drupal site.
1. Log in to your new Compute Instance using one of the methods below:

![Screenshot of the Drupal installation screen](drupal-install.png)
- **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. In the **Database configuration** screen, fill in the form with the values listed below. Click on **Save and Continue** when you are done.
1. Run the following command to access the credentials file:

- **Database name:** `drupaldb`
- **Database username:** `drupal`
- **Database password:** Enter the database user password you created when deploying the instance.
```command
cat /home/$USERNAME/.credentials
```

1. Continue to follow the prompts for the **Configure site** screen and select the appropriate configuration values for your Drupal site. When complete, you are brought to your Drupal site's admin panel where you can begin [building your Drupal site](https://www.drupal.org/documentation/build).
This returns passwords that were automatically generated when the instance was deployed. Save them. Once saved, you can safely delete the file.

![Screenshot of the Drupal admin panel](drupal-admin.png)
## Getting Started after Deployment

### Access your Drupal Site

To access your Drupal site:

1. Open a web browser and navigate to the domain you entered when creating the instance: `https://domain.tld`. If you didn't provide a domain, use your Compute Instance's default rDNS domain (`192-0-2-1.ip.linodeusercontent.com`). To learn more on viewing the rDNS value, see [Managing IP Addresses](/docs/products/compute/compute-instances/guides/manage-ip-addresses/). Make sure to use the `https` prefix in the URL to access the website securely.

## Software Included

Expand All @@ -66,13 +80,8 @@ The Drupal Marketplace App installs the following required software on your Lino
| **Software** | **Description** |
|:--------------|:------------|
| [**MariaDB Server**](https://mariadb.org/) | Relational database. |
| [**PHP 8**](https://www.php.net) | Drupal is written in PHP and requires PHP to operate. |
| [**PHP**](https://www.php.net) | Drupal is written in PHP and requires PHP to operate. |
| [**Apache HTTP Server**](https://httpd.apache.org) | Web Server used to serve the Drupal site. |
| [**Drupal 10**](https://www.drupal.org/about/10) | Content management system. |
| [**Drupal**](https://www.drupal.org/) | Content management system. |

{{% content "marketplace-update-note-shortguide" %}}

## Next Steps

- Register a domain name and [create a DNS record](/docs/products/networking/dns-manager/) for it using the Linode Cloud Manager.
- [Configure your Apache HTTP Server](/docs/guides/how-to-install-a-lamp-stack-on-debian-10/#configure-name-based-virtual-hosts) to point to your domain name.
2 changes: 1 addition & 1 deletion docs/marketplace-docs/guides/lamp-stack/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ A LAMP (Linux, [Apache](https://www.apache.org), [MySQL](https://www.mysql.com),

## Configuration Options

- **Supported distributions:** Ubuntu 22.04 LTS
- **Supported distributions:** Ubuntu 24.04 LTS
- **Recommended minimum plan:** 1GB Shared Compute Instance or higher, depending on the number of sites and size of the sites you plan on hosting.

### LAMP Stack Options
Expand Down
2 changes: 1 addition & 1 deletion docs/marketplace-docs/guides/lemp-stack/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The LEMP stack (Linux, [NGINX](https://www.nginx.com/), [MySQL](https://www.mysq

## Configuration Options

- **Supported distributions:** Ubuntu 22.04 LTS
- **Supported distributions:** Ubuntu 24.04 LTS
- **Recommended minimum plan:** 1GB Shared Compute Instance or higher, depending on the number of sites and size of the sites you plan on hosting.

### LEMP Stack Options
Expand Down
44 changes: 35 additions & 9 deletions docs/marketplace-docs/guides/rabbitmq/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,30 +29,56 @@ The RabbitMQ Marketplace App installs a RabbitMQ server and a basic default conf

## Configuration Options

- **Supported distributions:** Debian 10
- **Supported distributions:** Ubuntu 24.04 LTS
- **Recommended minimum plan:** All plan types and sizes can be used.

### RabbitMQ Options

- **RabbitMQ Username** *(required)*: The username for accessing the rabbitMQ management console.
- **RabbitMQ Password** *(required)*: The user password for SSH access to the Linode.
- **Email address** *(required)*: Email address to use for generating the SSL certificates and configuring the server and DNS records.
- **Allowed IPs** *(required)*: IP addresses allowed to access the Management UI.
- **The version of RabbitMQ you'd like installed** *(required)*: RabbitMQ version to be installed during the setup.
- **RabbitMQ Admin Username** *(required)*: RabbitMQ admin username.
- **RabbitMQ Username** *(required)*: RabbitMQ limited AMQP user. Make sure to use a username different from the **RabbitMQ Admin Username**.

{{% content "marketplace-required-limited-user-fields-shortguide" %}}

{{% content "marketplace-custom-domain-fields-shortguide" %}}

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

## Getting Started After Deployment
### Obtain the Credentials

Once the app is deployed, you need to obtain the credentials from the server.

To obtain 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. Open your web browser and navigate to the following URL, replacing *[ip-address]* with your Compute Instance's IPv4 address or default rDNS domain. See the [Managing IP Addresses](/docs/products/compute/compute-instances/guides/manage-ip-addresses/) guide for information on viewing IP addresses.
1. Run the following command to access the credentials file:

```command
http://[ip-address]:15672
cat /home/$USERNAME/.credentials
```

1. In the login form that appears, enter the username and password you created during the deployment. Then, click the **Login** button.
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

To get started:

1. Open a web browser and navigate to the domain you entered when creating the instance: `https://domain.tld`. If you didn't enter a domain, use your Compute Instance's default rDNS domain (`192-0-2-1.ip.linodeusercontent.com`). To learn more on viewing the rDNS value, see [Managing IP Addresses](/docs/products/compute/compute-instances/guides/manage-ip-addresses/). Make sure to use the `https` prefix in the URL to access the website securely.

1. Log in with your username and password found in your /home/$USERNAME/.credentials file.

![Screenshot of the RabbitMQ Login page](rabbitmq-login.png)

1. After you login successfully, you have full access to the RabbitMQ Management Console. From you, you can start configuring your application. To learn more about using RabbitMQ, visit the official [RabbitMQ Tutorials](https://www.rabbitmq.com/getstarted.html) page.
Now, you have full access to the RabbitMQ Management Console and you can start configuring your application.

![Screenshot of the RabbitMQ Management Console](rabbitmq-dashboard.png)

![Screenshot of the RabbitMQ Management Console](rabbitmq-dashboard.png)
To learn more on RabbitMQ, see [RabbitMQ Tutorials](https://www.rabbitmq.com/getstarted.html).

{{% content "marketplace-update-note-shortguide" %}}
30 changes: 20 additions & 10 deletions docs/marketplace-docs/guides/uptime-kuma/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,35 +27,45 @@ license: '[CC BY-ND 4.0](https://creativecommons.org/licenses/by-nd/4.0)'

## Configuration Options

- **Supported distributions:** Ubuntu 22.04 LTS
- **Supported distributions:** Ubuntu 24.04 LTS
- **Recommended plan:** All plan types and sizes can be used.

### Uptime Kuma Options

- **Email address** *(required)*: Enter the email address to use for generating the SSL certificates.
- **Uptime-Kuma Username** *(required)*: Enter the username to login to your Uptime-Kuma instance.

{{% content "marketplace-required-limited-user-fields-shortguide" %}}

{{% content "marketplace-custom-domain-fields-shortguide" %}}

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

## Getting Started after Deployment
### Obtain the Credentials

### Accessing the Uptime Kuma App
Once the app is deployed, you need to obtain the credentials from the server.

1. 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.
To obtain credentials:

![Screenshot of URL bar](uptimekuma-url.png)
1. Log in to your new Compute Instance using one of the methods below:

1. If this is your first time logging in, the account creation page appears. Complete the form and click the **Create** button.
- **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/).

![Screenshot of account creation form](uptimekuma-create-user.png)
1. Run the following command to access the credentials file:

1. After creating a user, you are automatically logged in and the Uptime Kuma dashboard is displayed.
```command
cat /home/$USERNAME/.credentials
```

![Screenshot of Uptime Kuma dashboard](uptimekuma-dashboard.png)
This returns passwords that were automatically generated when the instance was deployed. Save them. Once saved, you can safely delete the file.

Now that you’ve accessed your dashboard, check out [the official Uptime Kuma Repository](https://github.com/louislam/uptime-kuma) to learn how to further use your Uptime Kuma instance.
## Getting Started After Deployment

To get started:

1. Open a web browser and navigate to the domain you entered when creating the instance: `https://domain.tld`. If you didn't enter a domain, use your Compute Instance's default rDNS domain (`192-0-2-1.ip.linodeusercontent.com`). To learn more on viewing the rDNS value, see [Managing IP Addresses](/docs/products/compute/compute-instances/guides/manage-ip-addresses/). Make sure to use the `https` prefix in the URL to access the website securely.

1. Check [the official Uptime Kuma Repository](https://github.com/louislam/uptime-kuma) to learn how you can use your Uptime Kuma instance.

{{% content "marketplace-update-note-shortguide" %}}
34 changes: 19 additions & 15 deletions docs/marketplace-docs/guides/vscode/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,40 +28,44 @@ Run a [Visual Studio Code Server](https://github.com/cdr/code-server) in the bro

## Configuration Options

- **Supported distributions:** Debian 10
- **Supported distributions:** Ubuntu 24.04 LTS
- **Recommended minimum plan:** All plan types and sizes can be used.

### VS Code Options

- **The password used to log in to the VS Code Web UI** *(required)*: Enter a *strong* password that can be used to access VS Code.
- **Email address** *(required)*: Enter the email address to use for generating the SSL certificates as well as configuring the server and DNS records.
- **The version of VS Code Server you'd like installed** *(required)*: This is the version of VS Code Server that is installed during setup. The default at the time that this guide was written is 3.10.2. This field is filled in and it is recommended that you use this value. If you do not fill in this field, the latest version is used.
- **The version of VS Code Server you'd like installed** *(required)*: Enter the VS Code Server version to be installed during the setup.

{{% content "marketplace-limited-user-fields-shortguide" %}}
{{% content "marketplace-required-limited-user-fields-shortguide" %}}

{{% content "marketplace-custom-domain-fields-shortguide" %}}
- **Would you like to use a free Let's Encrypt SSL certificate?** Select `Yes` if you want the install to create an SSL certificate for you, or `No` if you do not. If `No` is selected, the VS Code app triggers security warnings in most web browsers. If you create a certificate and do not create a domain, the installer uses the Linode rDNS assigned name for the certificate.

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

## Getting Started after Deployment
### Obtain the Credentials

Once the app is deployed, you need to obtain the credentials from the server.

VS Code is now installed and ready to use.
To obtain the credentials:

1. Before you go to the app, if you filled out the optional VS Code configuration fields for domain:
1. Log in to your new Compute Instance using one of the methods below:

- In Cloud Manager's [DNS Manager](/docs/products/networking/dns-manager/guides/create-domain/) there is now an entry for the domain with possible subdomain records pointing to the new server.
- [Configure the rDNS](/docs/products/compute/compute-instances/guides/configure-rdns/) on the Linode server.
- **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. VS Code is accessed via the domain name if you entered one, or by the rDNS name if you did not. For example, `http://example.com` or `http://203-0-113-0.ip.linodeusercontent.com`, replacing the domain name or rDNS name with values for the server.
1. Run the following command to access the credentials file:

1. At the login screen, login using the password you entered during installation.
```command
cat /home/$USERNAME/.credentials
```

![Code Server Login Screen](vscode-login-screen.png "Code Server Login Screen")
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

1. After logging in, the VS Code Welcome screen appears in the browser and ready to code.
VS Code is now installed. To get started:

![VS Code Welcome Screen](vscode-welcome-screen.png "VS Code Welcome Screen")
1. Open a web browser and navigate to the domain you entered when creating the instance: `https://domain.tld`. If you did not enter a domain, use your Compute Instance's default rDNS domain (`192-0-2-1.ip.linodeusercontent.com`). To learn more on viewing the rDNS value, see [Managing IP Addresses](/docs/products/compute/compute-instances/guides/manage-ip-addresses/). Make sure to use the `https` prefix in the URL to access the website securely.
## Software Included
Expand Down

0 comments on commit a47acf0

Please sign in to comment.