Skip to content

Commit 13635fc

Browse files
authored
Merge pull request #7253 from hmorris3293/moodle-pihole
[update] Pihole & Moodle Marketplace app doc update
1 parent 5b462d6 commit 13635fc

File tree

2 files changed

+52
-19
lines changed

2 files changed

+52
-19
lines changed

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

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -29,34 +29,49 @@ Moodle is the most widely used open source learning management system. It is aim
2929

3030
## Configuration Options
3131

32-
- **Supported distributions:** Ubuntu 20.04 LTS
32+
- **Supported distributions:** Ubuntu 24.04 LTS
3333
- **Recommended minimum plan:** All plan types and sizes can be used.
3434

3535
### Moodle Options
3636

37-
- **Moodle Admin Password** *(required)*: Enter a *strong* password for the Moodle admin account.
38-
- **Moodle Admin Email** *(required)*: The email address you wish to use with the Moodle admin account.
39-
| **MySQL Root Password** *(required)*: Enter a *strong* password for the MySQL root user.
40-
- **Moodle database User Password** *(required)*: Enter a *strong* password for the database user.
41-
- **Limited sudo user** *(required)*: Enter your preferred username for the limited user.
42-
- **Password for the limited user** *(required)*: Enter a *strong* password for the new user.
37+
- **Email address** *(required)*: Enter the email address you want to use for generating the SSL certificates and configuring the server and DNS records.
38+
39+
- **Moodle Admin Username** *(required)*: Enter an admin username for the Moodle admin account.
40+
41+
- **Moodle Database Username** *(required)*: Enter a database username for the Moodle database admin.
42+
43+
{{% content "marketplace-required-limited-user-fields-shortguide" %}}
4344

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

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

48-
#### Limited User SSH Options (Optional)
49+
### Obtain the Credentials
50+
51+
Once the app is deployed, you need to obtain the credentials from the server.
52+
53+
To obtain the credentials:
54+
55+
1. Log in to your new Compute Instance using one of the methods below:
56+
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/).
59+
60+
1. Run the following command to access the credentials file:
61+
62+
```command
63+
cat /home/$USERNAME/.credentials
64+
```
4965

50-
- **SSH public key for the limited user:** If you wish to login as the limited user through public key authentication (without entering a password), enter your public key here. See [Creating an SSH Key Pair and Configuring Public Key Authentication on a Server](/docs/guides/use-public-key-authentication-with-ssh/) for instructions on generating a key pair.
51-
- **Disable root access over SSH:** To block the root user from logging in over SSH, select *Yes* (recommended). You can still switch to the root user once logged in and you can also log in as root through [Lish](/docs/products/compute/compute-instances/guides/lish/).
66+
This returns passwords that were automatically generated when the instance was deployed. Save them. Once saved, you can safely delete the file.
5267

5368
## Getting Started After Deployment
5469

5570
### Access Your Moodle App
5671

5772
To access your Moodle instance, Open a browser and navigate to your Linode rDNS domain `https://203-0-113-0.ip.linodeusercontent.com`. Replace `https://203-0-113-0.ip.linodeusercontent.com` with your [Linode's RDNS domain](/docs/products/compute/compute-instances/guides/manage-ip-addresses/#viewing-ip-addresses).
5873
59-
From there, you can login by clicking the box on the top right of the page. Once you see the login page, you can enter `moodle` as the *username* and the *password* that was entered during the creation of the Linode.
74+
From there, you can log in by clicking the box on the top right of the page. On the login page, enter the admin username you provided during the app deployment and the password stored in the credentials file.
6075
6176
Now that you’ve accessed your dashboard, checkout [the official Moodle documentation](https://docs.moodle.org/311/en/Main_page) to learn how to further configure your instance.
6277
@@ -67,7 +82,7 @@ The Moodle Marketplace App installs the following required software on your Lino
6782
| Software | Description |
6883
| -- | -- |
6984
| [**PHP**](https://www.php.net) | A popular general-purpose scripting language that is especially suited to web development. |
70-
| [**MariaDB Server**](https://mariadb.org) | A relational database server. The root password is set, locking down access outside the system. To gain access to the root user, obtain the password from `/root/.root_mysql_password` file. |
85+
| [**MariaDB Server**](https://mariadb.org) | A relational database server. The root password is set, locking down access outside the system.|
7186
| [**UFW**](https://wiki.ubuntu.com/UncomplicatedFirewall) | Firewall utility that allows access only for SSH (port 22, rate limited), HTTP (port 80), and HTTPS (port 443). |
7287
| [**Certbot**](https://certbot.eff.org) | Certbot is a fully-featured, easy-to-use, extensible client for the Let's Encrypt CA. |
7388
| [**Apache2**](https://httpd.apache.org) | HTTP Server. |

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

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,32 +29,50 @@ marketplace_app_name: "Pi-hole"
2929

3030
## Configuration Options
3131

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

3535
### Pi-hole Options
3636

37-
- **Pi-hole user password** *(required)*: This will be the password to get into the Pi-hole dashboard.
37+
- **Email address** *(required)*: Enter the email address you want to use for generating the SSL certificates and configuring the server and DNS records.
3838

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

4141
{{% content "marketplace-custom-domain-fields-shortguide" %}}
42-
- **Email address for the SOA record:** The start of authority (SOA) email address for this server. This is a required field if you want the installer to create DNS records.
4342

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

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+
4664
## Getting Started after Deployment
4765

4866
### Accessing the Pi-hole App
4967

5068
1. Open your web browser and navigate to `http://[domain]/admin`, where *[domain]* can be replaced with the custom domain you entered during deployment, your Compute Instance's rDNS domain (such as `192-0-2-1.ip.linodeusercontent.com`), or your IPv4 address. See the [Managing IP Addresses](/docs/products/compute/compute-instances/guides/manage-ip-addresses/) guide for information on viewing IP addresses and rDNS.
5169
52-
The Pi-Hole dashboard should now be displayed.
70+
The Pi-Hole dashboard opens.
5371
5472
![Screenshot of the Pi-hole dashboard](pihole-dashboard.png)
5573
56-
1. To log yourself in and access most of Pi-hole's features, click the **Login** link on the left menu. Enter the Pi-hole user password that you created when deploying the Compute Instance.
74+
1. To log in and access most of Pi-hole's features, in the main menu, click **Login**. Enter the Pi-hole user password that is found in your credentials file.
5775

58-
Now that you’ve accessed your dashboard, check out [the official Pi-hole documentation](https://docs.pi-hole.net/) to learn how to further use your Pi-hole instance.
76+
Check out [the official Pi-hole documentation](https://docs.pi-hole.net/) to learn how to further use your Pi-hole instance.
5977

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

0 commit comments

Comments
 (0)