diff --git a/ci/vale/dictionary.txt b/ci/vale/dictionary.txt index 707262f1218..cb18f8e0465 100644 --- a/ci/vale/dictionary.txt +++ b/ci/vale/dictionary.txt @@ -1225,6 +1225,7 @@ keysize keyspace keyspaces keystore +keystores kfctl khanaser kibana @@ -2566,6 +2567,7 @@ trie trivy trojan truststore +truststores tt ttl TTLs diff --git a/docs/products/tools/marketplace/guides/_index.md b/docs/products/tools/marketplace/guides/_index.md index 1c27e04bf51..40e275b2478 100644 --- a/docs/products/tools/marketplace/guides/_index.md +++ b/docs/products/tools/marketplace/guides/_index.md @@ -25,6 +25,7 @@ See the [Marketplace](/docs/marketplace/) listing page for a full list of all Ma - [Ant Media Server Enterprise Edition](/docs/products/tools/marketplace/guides/antmediaenterpriseserver/) - [Ant Media Server](/docs/products/tools/marketplace/guides/antmediaserver/) - [Apache Airflow](/docs/products/tools/marketplace/guides/apache-airflow/) +- [Apache Kafka Cluster](/docs/products/tools/marketplace/guides/apache-kafka-cluster/) - [Appwrite](/docs/products/tools/marketplace/guides/appwrite/) - [AzuraCast](/docs/products/tools/marketplace/guides/azuracast/) - [BeEF](/docs/products/tools/marketplace/guides/beef/) @@ -32,6 +33,7 @@ See the [Marketplace](/docs/marketplace/) listing page for a full list of all Ma - [Chevereto](/docs/products/tools/marketplace/guides/chevereto/) - [Cloudron](/docs/products/tools/marketplace/guides/cloudron/) - [ClusterControl](/docs/products/tools/marketplace/guides/clustercontrol/) +- [Couchbase Cluster](/docs/products/tools/marketplace/guides/couchbase-cluster/) - [Counter-Strike Global Offensive](/docs/products/tools/marketplace/guides/counter-strike-go/) - [cPanel](/docs/products/tools/marketplace/guides/cpanel/) - [CyberPanel](/docs/products/tools/marketplace/guides/cyberpanel/) diff --git a/docs/products/tools/marketplace/guides/antmediaenterpriseserver/ant-media-login.jpg b/docs/products/tools/marketplace/guides/antmediaenterpriseserver/ant-media-login.jpg new file mode 100644 index 00000000000..8f83d69eeb6 Binary files /dev/null and b/docs/products/tools/marketplace/guides/antmediaenterpriseserver/ant-media-login.jpg differ diff --git a/docs/products/tools/marketplace/guides/antmediaenterpriseserver/ant-media-server-create-account.png b/docs/products/tools/marketplace/guides/antmediaenterpriseserver/ant-media-server-create-account.png deleted file mode 100644 index cbd2f135e17..00000000000 Binary files a/docs/products/tools/marketplace/guides/antmediaenterpriseserver/ant-media-server-create-account.png and /dev/null differ diff --git a/docs/products/tools/marketplace/guides/antmediaenterpriseserver/index.md b/docs/products/tools/marketplace/guides/antmediaenterpriseserver/index.md index 5b0cdcdcc71..0baca20ef56 100644 --- a/docs/products/tools/marketplace/guides/antmediaenterpriseserver/index.md +++ b/docs/products/tools/marketplace/guides/antmediaenterpriseserver/index.md @@ -34,7 +34,7 @@ The Enterprise Edition of Ant Media Server requires a valid license to use the s ### Ant Media Server Options -- **SOA email address:** Enter the email address that should be used for the SSL generation. +- **Email address for the Ant Media Server Login & SSL Generation:** Enter the email address that should be used to log into the Ant Media Dashboard, and generate free Let's Encrypt SSL certificates. {{% content "marketplace-required-limited-user-fields-shortguide" %}} @@ -46,17 +46,36 @@ The Enterprise Edition of Ant Media Server requires a valid license to use the s ### Access the Ant Media Server Dashboard -1. Open your web browser and navigate to `https://[domain]:5443`, 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`). You can also use 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. +{{< note >}} +The Ant Media Server will deploy with an administrator account preconfigured using the email entered in the `email address` UDF on deployment. The generated password is in the `/home/$USERNAME/.credentials` along with the sudo user password. +{{< /note >}} + +1. Using [LISH](/docs/products/compute/compute-instances/guides/lish/) or [SSH](/docs/guides/connect-to-server-over-ssh/) connect to the instance and access the Ant Media Server credentials in the `/home/$USERNAME/.credentials` file. You will find an example of the output below. Keep in mind that $USERNAME will be replaced with your chosen sudo username. + + ```command + cat /home/$USERNAME/.credentials + ``` + + ```output + Sudo Username: $USERNAME + Sudo Password: Fs4WomBrHCI27M5fZg2PJfnW + Ant Media Server Username: antuser@akamai.com + Ant Media Server Password: 79KP106i3AxW8YOmaWA7FNVo + ``` + +1. Open your web browser and navigate to `https://[domain]:5443`, 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`). You can also use 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. + +1. Use the `Ant Media Server Username` and `Ant Media Server Password` from the `credentials` file to log into the Ant Media Dashboard. -1. After your account has been created, the login page appears. Enter the username and password that you just created. The username and password can be obtained in the `/home/$USERNAME/.credentials` file. + ![Screenshot of Ant Media Login](ant-media-login.jpg) -1. Once logged in, the Ant Media Server Dashboard appears. From here, you can manage your entire application. +1. Once logged in to the Ant Media Server Dashboard, you can manage your entire application. ![Screenshot of the Dashboard page](ant-media-server-dashboard.png) -1. To start using the Enterprise Edition of Ant Media Server, you need to obtain a license. Visit the [Self-Hosted Solutions](https://antmedia.io/#selfhosted) page on Ant Media's website to order a license. +1. To start using the Enterprise Edition of Ant Media Server, you need to obtain a license. Visit the [Self-Hosted Solutions](https://antmedia.io/#selfhosted) page on Ant Media's website to order a license. -1. Once the license key is obtained, navigate to the Settings tab within the Ant Media Dashboard, enter the License Key, and click save. +1. Once you obtained the license key, navigate to the Settings tab within the Ant Media Dashboard, enter the License Key, and click **Save**. ![Screenshot of the Settings Page](ant-media-server-settings.png) diff --git a/docs/products/tools/marketplace/guides/antmediaserver/ant-media-login.jpg b/docs/products/tools/marketplace/guides/antmediaserver/ant-media-login.jpg new file mode 100644 index 00000000000..8f83d69eeb6 Binary files /dev/null and b/docs/products/tools/marketplace/guides/antmediaserver/ant-media-login.jpg differ diff --git a/docs/products/tools/marketplace/guides/antmediaserver/ant-media-server-create-account.png b/docs/products/tools/marketplace/guides/antmediaserver/ant-media-server-create-account.png deleted file mode 100644 index cbd2f135e17..00000000000 Binary files a/docs/products/tools/marketplace/guides/antmediaserver/ant-media-server-create-account.png and /dev/null differ diff --git a/docs/products/tools/marketplace/guides/antmediaserver/index.md b/docs/products/tools/marketplace/guides/antmediaserver/index.md index fbbef000c48..aa72d320f38 100644 --- a/docs/products/tools/marketplace/guides/antmediaserver/index.md +++ b/docs/products/tools/marketplace/guides/antmediaserver/index.md @@ -2,7 +2,7 @@ title: "Deploy Ant Media Server Community Edition through the Linode Marketplace" description: 'This guide will show you how to install and configure Ant Media Server so you can stream video online using the Linode One-Click Marketplace App.' published: 2021-03-30 -modified: 2024-04-24 +modified: 2024-06-06 keywords: ['streaming', "marketplace", "live video streaming"] tags: ["marketplace", "linode platform", "cloud manager"] external_resources: @@ -45,7 +45,7 @@ If you need adaptive streaming, cluster, load balancer, and hardware encoding, c ### Ant Media Server Options -- **SOA email address:** Enter the email address that should be used for the SSL generation. +- **Email address for the Ant Media Server Login & SSL Generation:** Enter the email address that should be used to log into the Ant Media Dashboard, and generate free Let's Encrypt SSL certificates. {{% content "marketplace-required-limited-user-fields-shortguide" %}} @@ -57,17 +57,36 @@ If you need adaptive streaming, cluster, load balancer, and hardware encoding, c ### Access the Ant Media Server Dashboard -1. Open your web browser and navigate to `https://[domain]:5443`, 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`). You can also use 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. +{{< note >}} +The Ant Media Server will deploy with an administrator account preconfigured using the email entered in the `email address` UDF on deployment. The generated password can be found in `/home/$USERNAME/.credentials`, along with the sudo user password. +{{< /note >}} + +1. Using [LISH](/docs/products/compute/compute-instances/guides/lish/) or [SSH](/docs/guides/connect-to-server-over-ssh/) connect to the instance and access the Ant Media Server credentials in the `/home/$USERNAME/.credentials` file. You will find an example of the output below. Keep in mind that $USERNAME will be replaced with your chosen sudo username. + + ```command + cat /home/$USERNAME/.credentials + ``` + + ```output + Sudo Username: $USERNAME + Sudo Password: Fs4WomBrHCI27M5fZg2PJfnW + Ant Media Server Username: antuser@akamai.com + Ant Media Server Password: 79KP106i3AxW8YOmaWA7FNVo + ``` + +1. Open your web browser and navigate to `https://[domain]:5443`, 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`). You can also use 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. + +1. Use the `Ant Media Server Username` and `Ant Media Server Password` from the `credentials` file to log into the Ant Media Dashboard. -1. After your account has been created, the login page appears. Enter the username and password that you just created. The username and password can be obtained in the `/home/$USERNAME/.credentials` file. + ![Screenshot of Ant Media Login](ant-media-login.jpg) -1. Once logged in, the Ant Media Server Dashboard appears. From here, you can manage your entire application. +1. Once logged in to the Ant Media Server Dashboard, you can manage your entire application. ![Screenshot of the Dashboard page](ant-media-server-dashboard.png) -1. To start using the Enterprise Edition of Ant Media Server, you need to obtain a license. Visit the [Self-Hosted Solutions](https://antmedia.io/#selfhosted) page on Ant Media's website to order a license. +1. To start using the Enterprise Edition of Ant Media Server, you need to obtain a license. Visit the [Self-Hosted Solutions](https://antmedia.io/#selfhosted) page on Ant Media's website to order a license. -1. Once the license key is obtained, navigate to the Settings tab within the Ant Media Dashboard, enter the License Key, and click save. +1. Once the license key is obtained, navigate to the Settings tab within the Ant Media Dashboard, enter the License Key, and click **Save**. ![Screenshot of the Settings Page](ant-media-server-settings.png) diff --git a/docs/products/tools/marketplace/guides/apache-kafka-cluster/index.md b/docs/products/tools/marketplace/guides/apache-kafka-cluster/index.md new file mode 100644 index 00000000000..7fb73278607 --- /dev/null +++ b/docs/products/tools/marketplace/guides/apache-kafka-cluster/index.md @@ -0,0 +1,133 @@ +--- +title: "Deploy Apache Kafka through the Linode Marketplace" +description: Apache Kafka is a robust, scalable, and high-performance system for managing real-time data streams. Its versatile architecture and feature set make it an essential component for modern data infrastructure, supporting a wide range of applications from log aggregation to real-time analytics and more. Whether you are building data pipelines, event-driven architectures, or stream processing applications, Kafka provides a reliable foundation for your data needs." +published: 2024-06-10 +modified: 2024-06-10 +keywords: ['kafka','apache kafka', 'marketplace', 'streaming', 'queue'] +tags: ["ubuntu","marketplace", "streaming applications", "linode platform", "cloud manager", "ssl", "cloud storage", "high availability", "compute storage"] +external_resources: +- '[About Apache Kafka](https://kafka.apache.org/)' +- '[Apache Kafka Documentation](https://kafka.apache.org/documentation/)' +--- + +[Apache Kafka](https://kafka.apache.org/) is a robust, scalable, and high-performance system for managing real-time data streams. Its versatile architecture and feature set make it an essential component for modern data infrastructure, supporting a wide range of applications, from log aggregation to real-time analytics and more. Whether you are building data pipelines, event-driven architectures, or stream processing applications, Kafka provides a reliable foundation for your data needs. + +Our marketplace application allows the deployment of a Kafka cluster using Kafka's native consensus protocol, [KRaft](https://kafka.apache.org/documentation/#kraft). There are a few things to highlight from our deployment: + +- While provisioning, the cluster will be configured with mTLS for authentication. This means that inter-broker communication as well as client authentication is established via certificate identity. +- The minimum cluster size is 3. At all times, 3 controllers are configured in the cluster for fault-tolerance. +- Clients that connect to the cluster need their own valid certificate. All certificates are signed with a self-signed Certificate Authority (CA). Client keystores and truststore are found on the first Kafka node in `/etc/kafka/ssl/keystore` and `/etc/kafka/ssl/truststore` once the deployment is complete. +- The CA key and certificate pair are on the first Kafka node in `/etc/kafka/ssl/ca` once the deployment is complete. + + +## Cluster Deployment Architecture + +![Kafka Architecture](kafka-cluster.png) + +## Deploying a Marketplace App + +{{% content "deploy-marketplace-apps-shortguide" %}} + +{{% content "marketplace-verify-standard-shortguide" %}} + +{{< note >}} +**Estimated deployment time:** Your Kafka cluster should be fully installed within 5-7 minutes after the Compute Instance has finished provisioning. +{{< /note >}} + +## Configuration Options + +- **Supported distributions:** Ubuntu 22.04 LTS +- **Suggested minimum plan:** All plan types and sizes can be used depending on your storage needs. + +### Kafka Options + +- **[Linode API Token](/docs/products/tools/api/guides/manage-api-tokens/#create-an-api-token):** The provisioner node uses an authenticated API token to create the additional components to the cluster. This is required to fully create the Kafka cluster. + +{{% content "marketplace-required-limited-user-fields-shortguide" %}} + +- **Number of clients connecting to Kafka:** The number of clients that will be connecting to the cluster. The application will create SSL certificates for your client that need to connect to the cluster. This should be an integer equal or greater than 1. + +- **Kafka cluster size:** The size of the Kafka cluster. One of 3, 5 or 7 instances. + +- **Country or Region:** Enter the country or region for you or your organization. + +- **State or Province:** Enter the state or province for you or your organization. + +- **Locality:** Enter the town or other locality for you or your organization. + +- **Organization:** Enter the name of your organization. + +- **Email Address:** Enter the email address you wish to use for your certificate file. + +{{% content "marketplace-special-character-limitations-shortguide" %}} + +## Getting Started After Deployment + +### Obtain Keystore and Truststore + +Once the deployment is complete, obtain your client certificates from the first Kafka node. Authenticating clients requires a keystore and truststore. Access the first Kafka server and obtain your client keystores from `/etc/kafka/ssl/keystore` and `/etc/kafka/ssl/truststore`. Client certificates start with the word "client" and a number which depends on the number of clients you wanted, for example, **client1** and **client2**. + +We suggest transferring the client certificates to the Kafka consumer/producers using a secure method such as SSH or an encrypted HTTPS web UI. + +### Authentication + +Once you've copied over your keystores and truststores to your client, your client applications(s) will need the password to the keystore and truststore. The credentials can be found in the home directory of the sudo user created on deployment: `/home/$SUDO_USER/.credentials`. For example, if you created a user called `admin`, the credentials file will be found in `/home/admin/.credentials`. + +### Testing + +You can run a quick test from any of the Kafka nodes using Kafka's utilities found in `/etc/kafka/bin`. + +1. Create a file called `client.properties` with the following content: + + ```file {title="client.properties"} + security.protocol=SSL + ssl.truststore.location=/etc/kafka/ssl/truststore/server.truststore.jks + ssl.truststore.password=CHANGE-ME + ssl.keystore.location=/etc/kafka/ssl/keystore/client1.keystore.jks + ssl.keystore.password=CHANGE-ME + ``` + + Make sure that you update the values marked with **CHANGE-ME** with your own. + +1. Create a topic to test the connection and authentication: + + ```command + /etc/kafka/bin/kafka-topics.sh --create --topic test-ssl --bootstrap-server kafka3:9092 --command-config client.properties + ``` + + This results in the following output: + + ```output + Created topic test-ssl. + ``` + +1. Once the topic is created, you can publish a message to this topic as a producer: + + ```command + echo "Kafka rocks!" | /etc/kafka/bin/kafka-console-producer.sh --topic test-ssl --bootstrap-server kafka3:9092 --producer.config client.properties + ``` + +1. You can read the message as a consumer by issuing the following: + + ```command + /etc/kafka/bin/kafka-console-consumer.sh --topic test-ssl --from-beginning --bootstrap-server kafka3:9092 --consumer.config client.properties + ``` + + This results in the following output: + + ```output + Kafka rocks! + ``` + +## Software Included + +The Apache Kafka Marketplace App installs the following software on your Linode: + +| **Software** | **Version** | **Description** | +| :--- | :---- | :--- | +| **Apache Kafka** | 3.7.0 | Scalable, high-performance, fault-tolerant streaming processing application | +| **KRaft** | | Kafka native consensus protocol | +| **UFW** | 0.36.1 | Uncomplicated Firewall | +| **Fail2ban** | 0.11.2 | Brute force protection utility | + +{{% content "marketplace-update-note-shortguide" %}} \ No newline at end of file diff --git a/docs/products/tools/marketplace/guides/apache-kafka-cluster/kafka-cluster.png b/docs/products/tools/marketplace/guides/apache-kafka-cluster/kafka-cluster.png new file mode 100644 index 00000000000..7878cc14480 Binary files /dev/null and b/docs/products/tools/marketplace/guides/apache-kafka-cluster/kafka-cluster.png differ diff --git a/docs/products/tools/marketplace/guides/chevereto/index.md b/docs/products/tools/marketplace/guides/chevereto/index.md index ed8a96cfaf2..b805cf35052 100644 --- a/docs/products/tools/marketplace/guides/chevereto/index.md +++ b/docs/products/tools/marketplace/guides/chevereto/index.md @@ -2,7 +2,7 @@ title: "Deploy Chevereto through the Linode Marketplace" description: "This guide shows you how to install Chevereto, a modern image sharing solution with drag-and-drop upload experience and more, using the Linode One-Click Marketplace." published: 2021-08-13 -modified: 2022-05-17 +modified: 2022-06-06 keywords: ['photo storage','images','Marketplace'] tags: ["marketplace", "linode platform", "cloud manager"] external_resources: @@ -40,7 +40,7 @@ Chevereto requires a valid license to use the software. To purchase a license, v ssh root@192.0.2.0 -1. You should see the Chevereto welcome message when logging into the Linode. This includes instructions for accessing the Chevereto installation script in your web browser along with the location of the credentials to the application. Replace `192.0.2.0` with your Linode’s IP address. +1. You should see the Chevereto welcome message when logging into the Linode. This includes instructions for accessing the Chevereto installation script in your web browser, along with the location of the credentials to the application. Replace `192.0.2.0` with your Linode’s IP address. ![Chevereto Login Instruction](chevereto-login.png) @@ -48,11 +48,11 @@ Chevereto requires a valid license to use the software. To purchase a license, v ![Chevereto Installer](chevereto-installer.png) -1. To utilize Chevereto, you need to obtain a license key. You can do so clicking the purchase button and entering the license key provided by Chevereto. +1. To utilize Chevereto, you need to obtain a license key. You can do so by clicking the purchase button and entering the license key provided by Chevereto. ![Chevereto License](chevereto-license.png) -1. Next, you will be presented with a page where you can enter your cPanel credentials. Since this Marketplace App does not include a cPanel installation, you can simply select skip. +1. Next, you will be presented with a page where you can enter your cPanel credentials. Since this Marketplace App does not include a cPanel installation, you can select skip. ![Chevereto cPanel](chevereto-cpanel.png) @@ -72,6 +72,6 @@ Chevereto requires a valid license to use the software. To purchase a license, v ![Chevereto Final Install](chevereto-final_install.png) -Now that you’ve accessed your dashboard, checkout [the official Chevereto documentation](https://v3-docs.chevereto.com/) to learn how to further configure your instance. +Now that you’ve accessed your dashboard, check out [the official Chevereto documentation](https://v3-docs.chevereto.com/) to learn how to further configure your instance. {{% content "marketplace-update-note-shortguide" %}} \ No newline at end of file diff --git a/docs/products/tools/marketplace/guides/couchbase-cluster/couchbase_dashboard.png b/docs/products/tools/marketplace/guides/couchbase-cluster/couchbase_dashboard.png new file mode 100644 index 00000000000..8eb8126ac8e Binary files /dev/null and b/docs/products/tools/marketplace/guides/couchbase-cluster/couchbase_dashboard.png differ diff --git a/docs/products/tools/marketplace/guides/couchbase-cluster/couchbase_servers.png b/docs/products/tools/marketplace/guides/couchbase-cluster/couchbase_servers.png new file mode 100644 index 00000000000..081963a2cb9 Binary files /dev/null and b/docs/products/tools/marketplace/guides/couchbase-cluster/couchbase_servers.png differ diff --git a/docs/products/tools/marketplace/guides/couchbase-cluster/index.md b/docs/products/tools/marketplace/guides/couchbase-cluster/index.md new file mode 100644 index 00000000000..b2de169787c --- /dev/null +++ b/docs/products/tools/marketplace/guides/couchbase-cluster/index.md @@ -0,0 +1,72 @@ +--- +title: "Deploy Couchbase One-Click Cluster through the Linode Marketplace" +description: "Deploy Couchbase Enterprise Server One-Click Cluster on Akamai Connected Cloud. Couchbase Enterprise Server is a high-performance NoSQL database, designed for scale." +keywords: ['database','nosql','high availability','data','cluster'] +tags: ["marketplace", "linode platform", "cloud manager"] +published: 2024-06-10 +external_resources: +- '[Couchbase](https://www.couchbase.com/)' +--- + +[Couchbase](https://www.couchbase.com/) is an enterprise class NoSQL database designed with memory-first architecture, built-in cache and workload isolation. The Couchbase One-Click cluster deploys five connected Couchbase Enterprise Server nodes, split between data, index and query services. This starting configuration allows quick deployment and rapid cluster expansion with Couchbase's multi-dimensional scaling. + +{{< note title="Couchbase Enterprise Server License" >}} +Couchbase Enterprise Server is not free to use in production. Contact [Couchbase Support](https://www.couchbase.com/pricing/) to activate your license on Akamai Connected Cloud and enable [Couchbase application support](https://support.couchbase.com/hc/en-us/articles/360043247551-Accessing-Couchbase-Support). +{{< /note >}} + +## Deploying a Marketplace App + +{{% content "deploy-marketplace-apps-shortguide" %}} + +{{% content "marketplace-verify-standard-shortguide" %}} + +{{< note >}} +**Estimated deployment time:** Couchbase should be fully installed within 10-20 minutes after the Linode has finished provisioning. +{{< /note >}} + +## Configuration Options + +- **Supported distributions:** Ubuntu 22.04 LTS +- **Minimum plan:** Couchbase Enterprise Server requires 8GB of RAM. +- **Suggested Plan:** 16GB of RAM is suggested for production deployments. + +{{< note type="warning" title="Minimum RAM Requirements" >}} +**Minimum RAM Requirements:** Deploying the Couchbase Enterprise Server One-Click Cluster on a plan with less than 8GB of RAM will fail. Use caution, your account will be billed for any failed instances deployed with less than 8GB of RAM. +{{< /note >}} + +### Couchbase Options + +- **API Token** *(required)*: A valid API token with grants to deploy Linodes. + +- **Email address** *(required)*: Enter the email address to use for generating the SSL certificates. + +{{% content "marketplace-required-limited-user-fields-shortguide" %}} + +{{% content "marketplace-special-character-limitations-shortguide" %}} + +### Getting Started after Deployment + +## Accessing the Couchbase Server + +Access Couchbase's web UI by launching your preferred web browser and navigating to either the reverse DNS address of the *cluster provisioner*. This is the instance labeled `couchbase-occ-1-$region-$uuid`. If you need assistance in finding your instance's IP addresses and rDNS information, refer to the [Managing IP Addresses](/docs/products/compute/compute-instances/guides/manage-ip-addresses/) guide for detailed instructions. + +Provide the username Administrator and generated password included in `/home/$sudo_username/.credentials` to access the Dashboard. + +![Couchbase Dashboard](couchbase_dashboard.png) + +While there are no buckets yet configured on this new cluster, you can see all five nodes marked ready on the bottom status bar, and verify the status of the cluster members from the Servers tab. + +![Couchbase Servers Status](couchbase_servers.png) + +## Next Steps + +Now that your Couchbase Enterprise Server One-Click Cluster has been deployed, contact [Couchbase Support](https://www.couchbase.com/pricing/) to activate your license on this newly deployed cluster before using the cluster for testing, quality assurance, or in production. An active Enterprise License is required for any use other than solely for internal development use or evaluation of the software. + +### More Information + +You may wish to consult the following resources for additional information on this topic. We cannot guarantee for the accuracy or timeliness of externally hosted materials. + +- [Couchbase](https://www.couchbase.com/) +- [Couchbase Documentation](https://docs.couchbase.com/home/server.html) + +{{% content "marketplace-update-note-shortguide" %}} \ No newline at end of file diff --git a/docs/products/tools/marketplace/guides/hashicorp-nomad-clients-cluster/index.md b/docs/products/tools/marketplace/guides/hashicorp-nomad-clients-cluster/index.md index 127b51bd465..c1e4ca376f5 100644 --- a/docs/products/tools/marketplace/guides/hashicorp-nomad-clients-cluster/index.md +++ b/docs/products/tools/marketplace/guides/hashicorp-nomad-clients-cluster/index.md @@ -37,7 +37,7 @@ Please be aware that each Compute Instance will appear on your invoice as a sepa - **Linode API Token** *(required)*: Your API token is used to deploy additional Compute Instances as part of this cluster. At a minimum, this token must have Read/Write access to *Linodes*. If you do not yet have an API token, see [Get an API Access Token](/docs/products/tools/api/guides/manage-api-tokens/) to create one. -- **Limited sudo user** *(required)*: A limited user account with sudo access is created as part of this cluster deployment. Enter your preferred username for this limited user. Please note that the password is automatically created. +- **Limited sudo user** *(required)*: A limited user account with sudo access is created as part of this cluster deployment. Enter your preferred username for this limited user. The password is automatically created. - **consul_nomad_autojoin_token generated by Nomad Server OCC** *(required)*: This token is generated by the [HashiCorp Nomad Cluster](/docs/products/tools/marketplace/guides/hashicorp-nomad-cluster/) deployment and can be found in the `~/.deployment_secrets.txt` file created in your original cluster. diff --git a/docs/products/tools/marketplace/guides/hashicorp-nomad-cluster/index.md b/docs/products/tools/marketplace/guides/hashicorp-nomad-cluster/index.md index 6d2d18f0c02..b5697b57bf3 100644 --- a/docs/products/tools/marketplace/guides/hashicorp-nomad-cluster/index.md +++ b/docs/products/tools/marketplace/guides/hashicorp-nomad-cluster/index.md @@ -36,7 +36,7 @@ Please be aware that each Compute Instance will appear on your invoice as a sepa - **Linode API Token** *(required)*: Your API token is used to deploy additional Compute Instances as part of this cluster. At a minimum, this token must have Read/Write access to *Linodes*. If you do not yet have an API token, see [Get an API Access Token](/docs/products/tools/api/guides/manage-api-tokens/) to create one. -- **Limited sudo user** *(required)*: A limited user account with sudo access is created as part of this cluster deployment. Enter your preferred username for this limited user. Please note that the sudo password is automatically created and stored in the `~/.deployment_secrets.txt` file. See [Accessing the Nomad Web UI](#accessing-the-nomad-web-ui) below. +- **Limited sudo user** *(required)*: A limited user account with sudo access is created as part of this cluster deployment. Enter your preferred username for this limited user. The sudo password is automatically created and stored in the `~/.deployment_secrets.txt` file. See [Accessing the Nomad Web UI](#accessing-the-nomad-web-ui) below. - **Email Address** *(required)*: A valid SOA email address for auto-generated Let's Encrypt SSL. diff --git a/docs/products/tools/marketplace/guides/jupyterlab/index.md b/docs/products/tools/marketplace/guides/jupyterlab/index.md index 7ef6e85507d..ea8f1418da1 100644 --- a/docs/products/tools/marketplace/guides/jupyterlab/index.md +++ b/docs/products/tools/marketplace/guides/jupyterlab/index.md @@ -60,7 +60,7 @@ Once you have used the token, you will be able to access the JupyterLab base pag ### More Information -You may wish to consult the following resources for additional information on this topic. While these are provided in the hope that they will be useful, please note that we cannot vouch for the accuracy or timeliness of externally hosted materials. +You may wish to consult the following resources for additional information on this topic. While these are provided in the hope that they will be useful, we cannot vouch for the accuracy or timeliness of externally hosted materials. - [Project Jupyter](https://jupyter.org/) - [JupyterLab Documentation](https://jupyterlab.readthedocs.io/en/latest/) diff --git a/docs/products/tools/marketplace/guides/kepler/index.md b/docs/products/tools/marketplace/guides/kepler/index.md index d51e8b379ea..ed457052034 100644 --- a/docs/products/tools/marketplace/guides/kepler/index.md +++ b/docs/products/tools/marketplace/guides/kepler/index.md @@ -105,6 +105,6 @@ Now that your WordPress installation is deployed, you can start adding content a - [WordPress Support](https://wordpress.org/support/): Learn the basic workflows for using WordPress. - [Securing WordPress](/docs/guides/how-to-secure-wordpress/): Advice on securing WordPress through HTTPS, using a secure password, changing the admin username, and more. - [WordPress Themes](https://wordpress.org/themes/#): A collection of *thousands* of WordPress themes. -- [Marketplace Apps Repository](https://github.com/linode-solutions/marketplace-apps): Review the deployment Ansible playbooks. +- [Marketplace Apps Repository](https://github.com/akamai-compute-marketplace/marketplace-apps): Review the deployment Ansible playbooks. {{% content "marketplace-update-note-shortguide" %}} diff --git a/docs/products/tools/marketplace/guides/lamp-stack/index.md b/docs/products/tools/marketplace/guides/lamp-stack/index.md index 75853b7341e..2e8cd4c5bbc 100644 --- a/docs/products/tools/marketplace/guides/lamp-stack/index.md +++ b/docs/products/tools/marketplace/guides/lamp-stack/index.md @@ -72,6 +72,6 @@ The LAMP Stack Marketplace App installs the following software on your Linode: ## Going Further -- [Marketplace Apps Repository](https://github.com/linode-solutions/marketplace-apps): Review the deployment Ansible playbooks. +- [Marketplace Apps Repository](https://github.com/akamai-compute-marketplace/marketplace-apps): Review the deployment Ansible playbooks. {{% content "marketplace-update-note-shortguide" %}} diff --git a/docs/products/tools/marketplace/guides/lemp-stack/index.md b/docs/products/tools/marketplace/guides/lemp-stack/index.md index 3def260bd4a..c446aae5c32 100644 --- a/docs/products/tools/marketplace/guides/lemp-stack/index.md +++ b/docs/products/tools/marketplace/guides/lemp-stack/index.md @@ -71,6 +71,6 @@ The LEMP Stack Marketplace App installs the following software on your Compute I ## Going Further -- [Marketplace Apps Repository](https://github.com/linode-solutions/marketplace-apps): Review the deployment Ansible playbooks. +- [Marketplace Apps Repository](https://github.com/akamai-compute-marketplace/marketplace-apps): Review the deployment Ansible playbooks. {{% content "marketplace-update-note-shortguide" %}} diff --git a/docs/products/tools/marketplace/guides/mongodb-cluster/index.md b/docs/products/tools/marketplace/guides/mongodb-cluster/index.md index 862f2730628..8d027bdc675 100644 --- a/docs/products/tools/marketplace/guides/mongodb-cluster/index.md +++ b/docs/products/tools/marketplace/guides/mongodb-cluster/index.md @@ -38,7 +38,7 @@ This Marketplace App deploys 3 Compute Instances to create a highly available an - **Linode API Token** *(required)*: Your API token is used to deploy additional Compute Instances as part of this cluster. At a minimum, this token must have Read/Write access to *Linodes*. If you do not yet have an API token, see [Get an API Access Token](/docs/products/tools/api/guides/manage-api-tokens/) to create one. -- **Limited sudo user** *(required)*: A limited user account with sudo access is created as part of this cluster deployment. Enter your preferred username for this limited user. Please note that the password is automatically created. See [Obtaining Usernames and Passwords](#obtaining-usernames-and-passwords). +- **Limited sudo user** *(required)*: A limited user account with sudo access is created as part of this cluster deployment. Enter your preferred username for this limited user. The password is automatically created. See [Obtaining Usernames and Passwords](#obtaining-usernames-and-passwords). - **Domain** *(required)*: The domain name you wish to use, such as *example.com*. This domain name is only used as part of the system's hostname and when creating the TLS/SSL certificate. No domain records are created within Linode's [DNS Manager](/docs/products/networking/dns-manager/). diff --git a/docs/products/tools/marketplace/guides/openlitespeed-django/index.md b/docs/products/tools/marketplace/guides/openlitespeed-django/index.md index 2dac3c9f8eb..1167be30399 100644 --- a/docs/products/tools/marketplace/guides/openlitespeed-django/index.md +++ b/docs/products/tools/marketplace/guides/openlitespeed-django/index.md @@ -2,7 +2,7 @@ title: "Deploy OpenLiteSpeed Django through the Linode Marketplace" description: "Deploy OpenLiteSpeed Django on a Linode Compute Instance. This provides you with a high performance web server to manage your Django application." published: 2021-11-12 -modified: 2022-03-08 +modified: 2024-06-10 keywords: ['web server','django','openlitespeed'] tags: ["marketplace", "linode platform", "cloud manager"] external_resources: @@ -24,24 +24,47 @@ The OpenLiteSpeed Django app automatically installs Linux, the performance web s ## Configuration Options -- **Supported distributions:** CentOS 7, Ubuntu 20.04 LTS -- **Recommended plan:** All plan types and sizes can be used. +- **Supported distributions:** Ubuntu 22.04 LTS +- **Suggested plan:** All plan types and sizes can be used. + +## OpenLiteSpeed Django Options + +- **Django User** *(required)*: Username for Django app. +- **SOA Email Address:** *(required)*: Email address for free Let's Encrypt SSL certificates. + +{{% content "marketplace-required-limited-user-fields-shortguide" %}} + +{{% content "marketplace-custom-domain-fields-shortguide" %}} + +{{% content "marketplace-special-character-limitations-shortguide" %}} ## Getting Started after Deployment ### Accessing the OpenLiteSpeed Django App -1. Log in to your Compute Instance over SSH. See [Connecting to a Remote Server Over SSH -](/docs/guides/connect-to-server-over-ssh/) for assistance. You should see output similar to the following: +1. Log in to your Compute Instance over SSH, using the sudo user created during deployment or `root`. See [Connecting to a Remote Server Over SSH](/docs/guides/connect-to-server-over-ssh/) for assistance. You should see output similar to the following: + + ```output cat /etc/motd + ********************************************************* + Akamai Connected Cloud OpenLiteSpeed Django Marketplace App + App URL: + * The OpenLiteSpeed Web Admin: https://$EXAMPLE_DOMAIN:7080 + * The sample Django site: https://EXAMPLE_DOMAIN/ + * The Django admin user: $DJANGO_USER + * The sample Django admin page: https://$EXAMPLE_DOMAIN/admin + Credentials File: /home/$SUDO_USER/.credentials + Documentation: https://www.linode.com/marketplace/apps/linode/openlitespeed-django/ + ********************************************************* + ``` - ![OpenLiteSpeed Django setup information](setupinfo-django.png) + To delete this message of the day, use `rm /etc/motd`. -1. You are then prompted to enter the domain you'd like to use for this instance. You can optionally use a custom domain provided you've already configured the *A Records* to point to this server's IPv4 and IPv6 addresses. Otherwise, you can skip this by pressing *CTRL+C* which will use the IP address or default RDNS of the Compute Instance. +1. The Django page is automatically configured with the custom domain provided during deployment, or the default rDNS. {{< note >}} For more documentation on how to assign a domain to your Linode, please review the [DNS Manager](/docs/products/networking/dns-manager/) guide for instructions on setting up your DNS records in the Cloud Manager, and read through [DNS Records: An Introduction](/docs/guides/dns-overview/) for general information about how DNS works. {{< /note >}} -Now that you’ve accessed your OpenLiteSpeed Django instance, check out [the official OpenLiteSpeed Django documentation](https://docs.litespeedtech.com/cloud/images/django/) to learn how to further configure your OpenLiteSpeed Django instance. +Now that you’ve accessed your OpenLiteSpeed Django instance, check out [the official OpenLiteSpeed Django documentation](https://docs.litespeedtech.com/cloud/images/django/) for further configuration steps. {{% content "marketplace-update-note-shortguide" %}} \ No newline at end of file diff --git a/docs/products/tools/marketplace/guides/openlitespeed-wordpress/index.md b/docs/products/tools/marketplace/guides/openlitespeed-wordpress/index.md index 92ef953954d..d86baa424e3 100644 --- a/docs/products/tools/marketplace/guides/openlitespeed-wordpress/index.md +++ b/docs/products/tools/marketplace/guides/openlitespeed-wordpress/index.md @@ -2,7 +2,7 @@ title: "Deploy OpenLiteSpeed WordPress through the Linode Marketplace" description: "Deploy OpenLiteSpeed on a Linode Compute Instance. This provides you with a high performance web server to manage your WordPress site." published: 2021-01-15 -modified: 2022-03-08 +modified: 2024-06-06 keywords: [ 'openlitespeed','marketplace','hosting'] tags: ["cloud-manager","linode platform", "marketplace"] external_resources: @@ -12,7 +12,7 @@ external_resources: aliases: ['/platform/marketplace/deploy-openlitespeed-with-marketplace-apps/', '/platform/one-click/deploy-openlitespeed-with-one-click-apps/','/guides/deploy-openlitespeed-with-one-click-apps/','/guides/deploy-openlitespeed-with-marketplace-apps/', '/guides/openlitespeed-marketplace-app/','/guides/openlitespeed-wordpress-marketplace-app/'] --- -This Marketplace App installs the OpenLiteSpeed web server, WordPress, the LiteSpeed caching plugin for Wordpress, as well as other necessary software. Together, these applications provide an accelerated hosting platform for WordPress. [OpenLiteSpeed](https://openlitespeed.org/) is the open source edition of the LiteSpeed web server. It combines speed, security, scalability, optimization, and simplicity in one friendly open-source package. +This Marketplace App installs the OpenLiteSpeed web server, WordPress, the LiteSpeed caching plugin for WordPress, as well as other necessary software. Together, these applications provide an accelerated hosting platform for WordPress. [OpenLiteSpeed](https://openlitespeed.org/) is the open source edition of the LiteSpeed web server. It combines speed, security, scalability, optimization, and simplicity in one friendly open-source package. ## Deploying a Marketplace App @@ -26,37 +26,85 @@ This Marketplace App installs the OpenLiteSpeed web server, WordPress, the LiteS ## Configuration Options -- **Supported distributions:** Ubuntu 22.04 LTS, Debian 11, Debian 10, Ubuntu 20.04 LTS, CentOS 7 -- **Recommended minimum plan:** All plan types and sizes can be used. +- **Supported distributions:** Ubuntu 22.04 LTS +- **Suggested minimum plan:** All plan types and sizes can be used. + +### OpenLiteSpeed WordPress Options + +- **Email address** *(required)*: Enter the email address you wish to use when configuring the WordPress admin user, generating SSL certificates, and optionally creating DNS records for a custom domain. +- **WordPress Admin Username** *(required)*: Username for your WordPress admin user account. Defaults to `admin` if no username is entered. +- **WordPress Database Username** *(required)*: MySQL username for the WordPress database user. Defaults to `wordpress` if no username is entered. +- **WordPress Database Name** *(required)*: Name for the WordPress MySQL database. Defaults to `wordpress` if no database name is defined. +- **Website Title:** Enter a title for your WordPress site. + + {{< note >}} + The passwords for the WordPress Admin User, WordPress Database User and MySQL root user are automatically generated and provided in the file `/home/$USERNAME/.credentials` when the WordPress deployment completes. + {{< /note >}} + +{{% content "marketplace-required-limited-user-fields-shortguide" %}} + +{{% content "marketplace-custom-domain-fields-shortguide" %}} + +{{% content "marketplace-special-character-limitations-shortguide" %}} ## Getting Started After Deployment -1. Log in to your Compute Instance over SSH. See [Connecting to a Remote Server Over SSH -](/docs/guides/connect-to-server-over-ssh/) for assistance. Once logged in, you should see output that contains links to your new site, phpmyadmin, and details about the software configuration (and location) on your server. +Log in to your Compute Instance over SSH, using the `root` user or the sudo user created during deployment. See [Connecting to a Remote Server Over SSH](/docs/guides/connect-to-server-over-ssh/) for assistance. Once logged in, you should see Message of the Day output which includes OpenLiteSpeed HTTPS URLs: -1. You are then prompted to enter the domain you'd like to use for this instance. You can optionally use a custom domain provided you've already configured the *A Records* to point to this server's IPv4 and IPv6 addresses. Otherwise, you can skip this by pressing *CTRL+C* which will use the IP address or default RDNS of the Compute Instance. +```command +cat /etc/motd +``` + +```output +********************************************************* +Akamai Connected Cloud OpenLiteSpeed Wordpress Marketplace App +App URL: +* The Wordpress site: https://example-domain.tld/ +* The Wordpress admin login site: https://example-domain.tld/wp-login.php +* The phpMyAdmin site: https://example-domain.tld/phpmyadmin +* The LiteSpeed admin site: https://example-domain.tld:7080/login.php +Credentials File: /home/$SUDO_USERNAME/.credentials +Documentation: https://www.linode.com/marketplace/apps/linode/openlitespeed-wordpress/ +********************************************************* +``` + +The file `/home/$SUDO_USER/.credentials` includes chosen usernames and strong generated passwords for WordPress, OpenLiteSpeed and PHPMyAdmin users. It also includes passwords for the generated sudo user and MySQL root user. + +### Accessing the WordPress Admin Dashboard + +1. Open your web browser and navigate to `https://[domain]/wp-admin/`, 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`). You can also use your IPv4 address, though the connection will not be secure. See the [Managing IP Addresses](/docs/products/compute/compute-instances/guides/manage-ip-addresses/) guide for information on viewing IP addresses and rDNS. + + ![Screenshot of the browser's URL bar](wordpress-browser-url.png) {{< note >}} - For more documentation on how to assign a domain to your Linode, please review the [DNS Manager](/docs/products/networking/dns-manager/) guide for instructions on setting up your DNS records in the Cloud Manager, and read through [DNS Records: An Introduction](/docs/guides/dns-overview/) for general information about how DNS works. + A TLS/SSL certificate is automatically generated for your custom domain, enabling you to connect to the site over the `https` protocol. If you did not enter a custom domain, a TLS/SSL certificate is configured on the rDNS domain instead. Connections using your IP address are not secured and will use the `http` protocol. {{< /note >}} -1. Apply the Let's Encrypt SSL if your domain is pointed to the server already. Enter `y` and type your email address. +1. Within the login page that appears, enter the username (*admin username*) that you created when you deployed this instance and the associated password that was automatically generated. Then click the **Log In** button. + + ![Screenshot of the WordPress login form](wordpress-login.png) + +1. Once logged in, the WordPress Admin Dashboard appears. From here, you can create new posts, add users, modify the theme, and adjust any settings. - A message that reads `Certificate has been successfully installed.....` appears. If you'd like to force HTTPS rewrites, enter `y` again at the prompt. + ![Screenshot of the WordPress dashboard](wordpress-admin.png) -1. Proceed through any remaining prompts, using whichever options you wish. +1. You can also access the OpenLiteSpeed Admin page for cache and webserver specific settings at `https://[domain]].tld:7080/login.php`. -### Configure WordPress + ![Screenshot of OpenLiteSpeed Admin login page](openlitespeed_login_page.jpg) -1. Open a web browser and navigate to your Compute Instance's IPv4 address or the custom domain you are using. The following page appears: +1. PHPMyAdmin Web UI is available at `https://[domain]/phpmyadmin`. - ![WordPress language settings](wordpress_language_settings.png "WordPress language selection") + ![Screenshot of PHPMyAdmin login page](phpmyadmin_login_page.jpg) -1. Select your preferred language and click the **Continue** button. +## Going Further -1. The next page should be the **Welcome** page. Type the required details to complete the installation, save the password in a secure location and click the **Install WordPress** button. +Now that OpenLiteSpeed WordPress has been fully deployed, you can begin adding content and modifying the sites. The following support documents are available: - ![WordPress Welcome Page ](wordpress_welcome_page.png "WordPress Welcome Page") +- See the Linode tab at: https://docs.litespeedtech.com/cloud/images/wordpress/ +- [WordPress Support](https://wordpress.org/support/): Learn the basic workflows for using WordPress. +- [Securing WordPress](/docs/guides/how-to-secure-wordpress/): Advice on securing WordPress through HTTPS, using a secure password, changing the admin username, and more. +- [WordPress Themes](https://wordpress.org/themes/#): A collection of *thousands* of WordPress themes. +- [Marketplace Apps Repository](https://github.com/akamai-compute-marketplace/marketplace-apps): Review the deployment Ansible playbooks. ### Software Included diff --git a/docs/products/tools/marketplace/guides/openlitespeed-wordpress/openlitespeed_login_page.jpg b/docs/products/tools/marketplace/guides/openlitespeed-wordpress/openlitespeed_login_page.jpg new file mode 100644 index 00000000000..58ae9632331 Binary files /dev/null and b/docs/products/tools/marketplace/guides/openlitespeed-wordpress/openlitespeed_login_page.jpg differ diff --git a/docs/products/tools/marketplace/guides/openlitespeed-wordpress/phpmyadmin_login_page.jpg b/docs/products/tools/marketplace/guides/openlitespeed-wordpress/phpmyadmin_login_page.jpg new file mode 100644 index 00000000000..c2ee4edb945 Binary files /dev/null and b/docs/products/tools/marketplace/guides/openlitespeed-wordpress/phpmyadmin_login_page.jpg differ diff --git a/docs/products/tools/marketplace/guides/openlitespeed-wordpress/wordpress-admin.png b/docs/products/tools/marketplace/guides/openlitespeed-wordpress/wordpress-admin.png new file mode 100644 index 00000000000..d80ae8a5074 Binary files /dev/null and b/docs/products/tools/marketplace/guides/openlitespeed-wordpress/wordpress-admin.png differ diff --git a/docs/products/tools/marketplace/guides/openlitespeed-wordpress/wordpress-browser-url.png b/docs/products/tools/marketplace/guides/openlitespeed-wordpress/wordpress-browser-url.png new file mode 100644 index 00000000000..c55b57dbc4c Binary files /dev/null and b/docs/products/tools/marketplace/guides/openlitespeed-wordpress/wordpress-browser-url.png differ diff --git a/docs/products/tools/marketplace/guides/openlitespeed-wordpress/wordpress-login.png b/docs/products/tools/marketplace/guides/openlitespeed-wordpress/wordpress-login.png new file mode 100644 index 00000000000..814b4434e92 Binary files /dev/null and b/docs/products/tools/marketplace/guides/openlitespeed-wordpress/wordpress-login.png differ diff --git a/docs/products/tools/marketplace/guides/openlitespeed-wordpress/wordpress_language_settings.png b/docs/products/tools/marketplace/guides/openlitespeed-wordpress/wordpress_language_settings.png deleted file mode 100644 index df96faa3c82..00000000000 Binary files a/docs/products/tools/marketplace/guides/openlitespeed-wordpress/wordpress_language_settings.png and /dev/null differ diff --git a/docs/products/tools/marketplace/guides/openlitespeed-wordpress/wordpress_welcome_page.png b/docs/products/tools/marketplace/guides/openlitespeed-wordpress/wordpress_welcome_page.png deleted file mode 100644 index 7889fefef43..00000000000 Binary files a/docs/products/tools/marketplace/guides/openlitespeed-wordpress/wordpress_welcome_page.png and /dev/null differ diff --git a/docs/products/tools/marketplace/guides/plesk/index.md b/docs/products/tools/marketplace/guides/plesk/index.md index 1dd9c2973a1..1b81051784c 100644 --- a/docs/products/tools/marketplace/guides/plesk/index.md +++ b/docs/products/tools/marketplace/guides/plesk/index.md @@ -2,7 +2,7 @@ title: "Deploy Plesk through the Linode Marketplace" description: "This guide shows how to install and configure Plesk using the Linode Marketplace Apps. Plesk is a leading WordPress and website management control panel." published: 2019-03-25 -modified: 2022-03-08 +modified: 2024-05-21 keywords: ['plesk','marketplace', 'cms'] tags: ["linode platform","cms","marketplace","cloud-manager"] external_resources: @@ -26,9 +26,13 @@ aliases: ['/platform/marketplace/deploying-plesk-with-marketplace-apps/','/guide ## Configuration Options -- **Supported distributions:** CentOS 7, Ubuntu 20.04 LTS -- **Recommended minimum plan:** All plan types and sizes can be used. +- **Supported distributions:** Ubuntu 22.04 LTS +- **Suggested minimum plan:** All plan types and sizes can be used. +- **SOA Email Address** *(required):* An email address for free Let's Encrypt SSL. +{{% content "marketplace-required-limited-user-shortguide" %}} + +{{% content "marketplace-custom-domain-fields-shortguide" %}} ## Getting Started after Deployment ### Access your Plesk Site @@ -37,11 +41,7 @@ aliases: ['/platform/marketplace/deploying-plesk-with-marketplace-apps/','/guide https://[domain]/login_up.php - {{< note type="alert" >}} - The Plesk dashboard is only accessible over an *HTTPS* connection (not *HTTP*). When accessing it, your browser may warn you that the connection is not private, is not secure, or that there is a potential security risk. You must accept this risk to continue. - {{< /note >}} - -1. Once you navigate to that URL, a login prompt appears. Use the following credentials. +1. Once you navigate to the URL, a login prompt appears. Use the following credentials: - **Username:** `root` - **Password:** The root password you entered when creating the Compute Instance. diff --git a/docs/products/tools/marketplace/guides/plex/index.md b/docs/products/tools/marketplace/guides/plex/index.md index 1f7ee89d54b..cd65aa80829 100644 --- a/docs/products/tools/marketplace/guides/plex/index.md +++ b/docs/products/tools/marketplace/guides/plex/index.md @@ -2,7 +2,7 @@ title: "Deploy Plex Media Server through the Linode Marketplace" description: "Stream your personal media collection to nearly any device with your own Plex Media Server using Linode Marketplace Apps." published: 2020-09-28 -modified: 2022-03-08 +modified: 2024-06-06 keywords: ['streaming','plex','video','media server'] tags: ["debian","docker","marketplace", "web applications","linode platform", "cloud manager"] image: Deploy_Plex_oneclickapps.png @@ -41,9 +41,9 @@ The following configuration options create a secure [Limited User](/docs/product - The Limited User configurations below are for your Linode's [Linux user](/docs/guides/linux-users-and-groups/), which is distinct from your [Plex account user](https://www.plex.tv/sign-up/). {{< /note >}} -- **Limited User Name** *(required)*: Enter your preferred username for the limited user. If the username `root` is specified, a limited user is not be created and extra security features are not configured. +- **Limited User Name** *(required)*: Enter your preferred username for the limited user. If the username `root` is specified, a limited user is not created and extra security features are not configured. - **Limited User Password** *(required)*: Enter a *strong* password for the new user. -- **Limited User SSH Key:** 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. +- **Limited User SSH Key:** If you wish to log in 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. {{% content "marketplace-special-character-limitations-shortguide" %}} @@ -81,7 +81,7 @@ Your shell then interprets `$IP_ADDRESS` as the value you have provided in follo You now have an established SSH connection to your Plex Server Linode in your terminal, and can also access the Plex web interface from your workstation browser. -1. Enter `http://localhost:8888/web` into your workstation browser to access the Plex Server setup web interface. Enter your Plex account username and password to proceed with the setup process. +1. Enter `http://localhost:8888/web` into your workstation browser to access the Plex Server setup web interface. Enter your Plex account username and password to proceed with the setup. ![Plex Login Screen](plex-login.png "Plex login screen.") @@ -101,7 +101,7 @@ Your shell then interprets `$IP_ADDRESS` as the value you have provided in follo ![Plex Settings Icon](initial-setup-settings-icon.png "Plex Settings Icon.") -1. On the left side bar, ensure that your new Plex Server is selected and select on **Remote Access** under the **Settings** section. +1. On the left side bar, ensure that your new Plex Server is selected and select **Remote Access** under the **Settings** section. ![Plex Server Remote Access Settings](initial-setup-remote-access.png "Plex Remote Access Settings.") diff --git a/docs/products/tools/marketplace/guides/postgresql-cluster/index.md b/docs/products/tools/marketplace/guides/postgresql-cluster/index.md index b880a4fce30..f80868263f0 100644 --- a/docs/products/tools/marketplace/guides/postgresql-cluster/index.md +++ b/docs/products/tools/marketplace/guides/postgresql-cluster/index.md @@ -34,7 +34,7 @@ This Marketplace App deploys 3 Compute Instances to create a highly available an - **Linode API Token** *(required)*: Your API token is used to deploy additional Compute Instances as part of this cluster. At a minimum, this token must have Read/Write access to *Linodes*. If you do not yet have an API token, see [Get an API Access Token](/docs/products/tools/api/guides/manage-api-tokens/) to create one. -- **Limited sudo user** *(required)*: A limited user account with sudo access is created as part of this cluster deployment. Enter your preferred username for this limited user. Please note that the password is automatically created. See [Obtaining Usernames and Passwords](#obtaining-usernames-and-passwords). +- **Limited sudo user** *(required)*: A limited user account with sudo access is created as part of this cluster deployment. Enter your preferred username for this limited user. The password is automatically created. See [Obtaining Usernames and Passwords](#obtaining-usernames-and-passwords). - **Domain** *(required)*: The domain name you wish to use, such as *example.com*. This domain name is only used to identify your cluster and as part of the system's hostname. No domain records are created within Linode's [DNS Manager](/docs/products/networking/dns-manager/). diff --git a/docs/products/tools/marketplace/guides/prometheus-grafana/index.md b/docs/products/tools/marketplace/guides/prometheus-grafana/index.md index 3fcf7942e51..aa576d50d74 100644 --- a/docs/products/tools/marketplace/guides/prometheus-grafana/index.md +++ b/docs/products/tools/marketplace/guides/prometheus-grafana/index.md @@ -2,7 +2,7 @@ title: "Deploy Prometheus and Grafana through the Linode Marketplace" description: "Deploy Prometheus & Grafana on a Linode Compute Instance. This application provides you with a reliable monitoring solution for all of your infrastructure. " published: 2022-03-29 -modified: 2024-04-29 +modified: 2024-05-14 keywords: ['monitoring','observability'] tags: ["marketplace", "linode platform", "cloud manager"] external_resources: @@ -30,13 +30,13 @@ Grafana is an analytics and monitoring solution with a focus on accessibility fo ## Configuration Options - **Supported distributions:** Ubuntu 22.04 LTS -- **Recommended plan:** All plan types and sizes can be used. +- **Suggested plan:** All plan types and sizes can be used. ### Prometheus and Grafana Options - **Email address** *(required)*: Enter the email address to use for generating the SSL certificates. -{{% content "marketplace-limited-user-fields-shortguide" %}} +{{% content "marketplace-required-limited-user-fields-shortguide" %}} {{% content "marketplace-custom-domain-fields-shortguide" %}} @@ -55,29 +55,39 @@ Once the app has been *fully* deployed, you need to obtain the credentials from 1. Log in to your new Compute Instance using one of the methods below: - **Lish Console:** Within the Cloud Manager, navigate to **Linodes** from the left menu, select the Compute Instance you just deployed, and click the **Launch LISH Console** button. Log in as the `root` user. 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. See [Connecting to a Remote Server Over SSH](/docs/guides/connect-to-server-over-ssh/) for assistance. + - **SSH:** Log in to your Compute Instance over SSH using the `root` user, or with the sudo user created during deployment. See [Connecting to a Remote Server Over SSH](/docs/guides/connect-to-server-over-ssh/) for assistance. -1. Once logged in, run the following command: +1. Once logged in, find the URLs and credential files listed in the MOTD: ```command - cat /root/credentials.txt + cat /etc/motd ``` -1. This displays the credentials and endpoint URL for both Prometheus and Grafana, as shown in the example output below. + ```output + ********************************************************* + Akamai Connected Cloud Prometheus & Grafana Marketplace App + Grafana URL: https://$EXAMPLE_DOMAIN.COM + Prometheus URL: https://$EXAMPLE_DOMAIN.COM/prometheus + Credentials File: /home/$SUDO_USER/.credentials + Documentation: https://www.linode.com/docs/products/tools/marketplace/guides/prometheus-grafana/ + ********************************************************* + ``` + + To delete this message of the day, use `rm /etc/motd`. + +1. The `/home/$SUDO_USER/.credentials` file contains the credentials for the created sudo user, Prometheus, and Grafana, as shown in the example output below: + + ```command + cat /home/$SUDO_USER/.credentials + ``` ```output - ################# - # Prometheus # - ################# - Location: https://192-0-2-1.ip.linodeusercontent.com/prometheus - Username: prometheus - Password: htyjuykuyhjyrkit648648#$#%^GDGHDHTTNJMYJTJ__gr9jpoijrpo - ############## - # Grafana # - ############## - Location: https://192-0-2-1.ip.linodeusercontent.com - Username: admin - Password: ewtghwethetrh554y35636#$_0noiuhr09h) + Sudo Username: $SUDO_USER + Sudo Password: QAV!BHw3Ud-EcM4XYt3q + Prometheus Username: prometheus + Prometheus Password: XnYGi8CTPNKugQhaC9@2nze6 + Grafana Username: admin + Grafana Password: *qs6.rbpWyb_rwKm3ciFYW82 ``` ### Add Prometheus as a Data Source to Grafana diff --git a/docs/products/tools/marketplace/guides/redis-cluster/index.md b/docs/products/tools/marketplace/guides/redis-cluster/index.md index 22f0fc4aede..ab1b3a8f3dc 100644 --- a/docs/products/tools/marketplace/guides/redis-cluster/index.md +++ b/docs/products/tools/marketplace/guides/redis-cluster/index.md @@ -34,7 +34,7 @@ This Marketplace App deploys 3 or 5 Compute Instances to create a highly availab - **Linode API Token** *(required)*: Your API token is used to deploy additional Compute Instances as part of this cluster. At a minimum, this token must have Read/Write access to *Linodes*. If you do not yet have an API token, see [Get an API Access Token](/docs/products/tools/api/guides/manage-api-tokens/) to create one. -- **Limited sudo user** *(required)*: A limited user account with sudo access is created as part of this cluster deployment. Enter your preferred username for this limited user. Please note that the password is automatically created. See [Obtaining Usernames and Passwords](#obtaining-usernames-and-passwords). +- **Limited sudo user** *(required)*: A limited user account with sudo access is created as part of this cluster deployment. Enter your preferred username for this limited user. The password is automatically created. See [Obtaining Usernames and Passwords](#obtaining-usernames-and-passwords). - **Add SSH Keys to all nodes?** If you select *yes*, any SSH Keys that are added to the root user account (in the **SSH Keys** section), are also added to your limited user account on all deployed Compute Instances. diff --git a/docs/products/tools/marketplace/guides/wazuh/index.md b/docs/products/tools/marketplace/guides/wazuh/index.md index 987e3bf520d..8d9e3eaf5a8 100644 --- a/docs/products/tools/marketplace/guides/wazuh/index.md +++ b/docs/products/tools/marketplace/guides/wazuh/index.md @@ -2,7 +2,7 @@ title: "Deploy Wazuh through the Linode Marketplace" description: "Deploy Wazuh on a Linode Compute Instance. This provides you with an open source a security monitoring solution." published: 2021-11-12 -modified: 2023-09-11 +modified: 2024-06-06 keywords: ['security','vulnerability','monitoring'] tags: ["marketplace", "linode platform", "cloud manager"] external_resources: @@ -25,13 +25,13 @@ aliases: ['/guides/deploying-wazuh-marketplace-app/','/guides/wazuh-marketplace- ## Configuration Options - **Supported distributions:** Ubuntu 22.04 LTS -- **Recommended plan:** Wazuh recommends a minimum of a 4GB Linode, though an 8-core plan (32GB and up) is recommended for production. +- **Suggested plan:** Wazuh suggests a minimum of a 4GB Linode, though an 8-core plan (32GB and up) is recommended for production. ### Wazuh Options -- **Email address** *(required)*: Enter the email address to use for generating the SSL certificates. +- **SOA Email Address** *(required)*: Enter the email address to use for generating the SSL certificates. -{{% content "marketplace-limited-user-fields-shortguide" %}} +{{% content "marketplace-required-limited-user-fields-shortguide" %}} {{% content "marketplace-custom-domain-fields-shortguide" %}} @@ -41,12 +41,12 @@ aliases: ['/guides/deploying-wazuh-marketplace-app/','/guides/wazuh-marketplace- ### View Credentials -1. Log into your new Compute Instance through [LISH](/docs/products/compute/compute-instances/guides/lish/) or [SSH](/docs/products/compute/compute-instances/guides/set-up-and-secure/#connect-to-the-instance) using the root user and the password you entered when creating the instance. +1. Log into your new Compute Instance through [LISH](/docs/products/compute/compute-instances/guides/lish/) or [SSH](/docs/products/compute/compute-instances/guides/set-up-and-secure/#connect-to-the-instance) using either `root` user and the password you entered when creating the instance, or the generated sudo user and supplied SSH key. -1. The usernames and passwords have been saved in a `.deployment-secrets.txt` file located in your root directory. You can view this file in your preferred text editor or through the `cat` command. +1. The usernames and passwords have been saved in the `/home/$SUDO_USER/.credentials` file, where sudo user is the user created during deployment. You can view this file in your preferred text editor or through the `cat` command. ```command - cat /root/.deployment-secrets.txt + cat /home/$SUDO_USER/.credentials ``` This file contains all of your Wazuh credentials. The admin user and its associated password are needed when following the [Access the Wazuh App](#access-the-wazuh-app) section below. @@ -60,7 +60,7 @@ aliases: ['/guides/deploying-wazuh-marketplace-app/','/guides/wazuh-marketplace- indexer_username: 'kibanaserver' indexer_password: 'Z.0M8rorxRS+DQfefe96N?.Cb+?byn7k' - # Regular Dashboard user, only has read permissions to all indices and all permissions on the .kibana index + # Regular Dashboard user, only has READ permissions to all indices and all permissions on the .kibana index indexer_username: 'kibanaro' indexer_password: 'W?PVE08Pk2AYE8*brrg4Ni+LXAbBKJl++2II' @@ -87,9 +87,9 @@ aliases: ['/guides/deploying-wazuh-marketplace-app/','/guides/wazuh-marketplace- ### Access the Wazuh App -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. +1. Open a web browser and navigate to the domain you entered when creating the `https://domain.tld` instance. 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. -1. In the login screen that appears, enter `admin` as the username and enter its corresponding password (which can be found by following the [View Credentials](#view-credentials) section). +1. In the login screen that appears, enter `admin` as the username and enter its corresponding password. Find the password by following the steps in the [View Credentials](#view-credentials) section. ![Screenshot of the login page](wuzah-login.png) diff --git a/docs/products/tools/marketplace/guides/wireguard/index.md b/docs/products/tools/marketplace/guides/wireguard/index.md index 2085fb709cc..f708f116915 100644 --- a/docs/products/tools/marketplace/guides/wireguard/index.md +++ b/docs/products/tools/marketplace/guides/wireguard/index.md @@ -46,7 +46,7 @@ Your WireGuard configuration can be adjusted after you first set up your Marketp The WireGuard Marketplace form includes fields for your WireGuard client's [*public key*](https://www.wireguard.com/quickstart/#key-generation) and for your client's *endpoint IP* (which is your client's public IP address). If you have already set up your client and installed the WireGuard software on it prior to setting up your WireGuard Marketplace App, then you may already have this information. If you do have the key and the endpoint IP for the client, you can enter them into the app's creation form, and your server's configuration will be pre-populated with those values. {{< note >}} -Please note that a public key generated by WireGuard will not resemble [a public key that you might use for SSH connections](/docs/guides/use-public-key-authentication-with-ssh/); when in doubt, leave the form's **Public Key (Client)** field blank. +A public key generated by WireGuard will not resemble [a public key that you might use for SSH connections](/docs/guides/use-public-key-authentication-with-ssh/); when in doubt, leave the form's **Public Key (Client)** field blank. {{< /note >}} If you do not have the values for these fields, you can leave them empty. After the app is deployed, visit the [Configure and Connect your WireGuard Client and Server](#configure-and-connect-your-wireguard-client-and-server) section to set up your client and generate a key. The instructions in that section will also show you how to insert the key and the endpoint IP for your client into your server's configuration. diff --git a/docs/products/tools/marketplace/guides/woocommerce/index.md b/docs/products/tools/marketplace/guides/woocommerce/index.md index 2b8cfcdf3da..3ad8979b952 100644 --- a/docs/products/tools/marketplace/guides/woocommerce/index.md +++ b/docs/products/tools/marketplace/guides/woocommerce/index.md @@ -115,6 +115,6 @@ Now that your WordPress installation is deployed, you can start adding content a - [WordPress Support](https://wordpress.org/support/): Learn the basic workflows for using WordPress. - [Securing WordPress](/docs/guides/how-to-secure-wordpress/): Advice on securing WordPress through HTTPS, using a secure password, changing the admin username, and more. - [WordPress Themes](https://wordpress.org/themes/#): A collection of *thousands* of WordPress themes. -- [Marketplace Apps Repository](https://github.com/linode-solutions/marketplace-apps): Review the deployment Ansible playbooks. +- [Marketplace Apps Repository](https://github.com/akamai-compute-marketplace/marketplace-apps): Review the deployment Ansible playbooks. {{% content "marketplace-update-note-shortguide" %}} diff --git a/docs/products/tools/marketplace/guides/wordpress/index.md b/docs/products/tools/marketplace/guides/wordpress/index.md index 1f3a6daa80b..324165a0f1b 100644 --- a/docs/products/tools/marketplace/guides/wordpress/index.md +++ b/docs/products/tools/marketplace/guides/wordpress/index.md @@ -2,7 +2,7 @@ title: "Deploy WordPress through the Linode Marketplace" description: "WordPress is an industry standard CMS. Follow this guide to deploy WordPress on Linode using Marketplace Apps." published: 2020-09-28 -modified: 2024-04-16 +modified: 2024-05-14 keywords: ['wordpress','wp cli','marketplace apps', 'cms', 'deploy wordpress with marketplace', 'easy install wordpress'] tags: ["debian","cloud manager","linode platform","cms","wordpress","marketplace","ssl","web applications"] external_resources: @@ -45,6 +45,7 @@ aliases: ['/platform/marketplace/deploying-wordpress-with-marketplace-apps/', '/ {{% content "marketplace-custom-domain-fields-shortguide" %}} {{% content "marketplace-special-character-limitations-shortguide" %}} +- **Prometheus Exporter:** Option to include built in Prometheus endpoints for Node Exporter and MySQLd Exporter. See [Prometheus Exporters](https://prometheus.io/docs/instrumenting/exporters/). ## Getting Started After Deployment @@ -140,6 +141,6 @@ Now that your WordPress installation is deployed, you can start adding content a - [WordPress Support](https://wordpress.org/support/): Learn the basic workflows for using WordPress. - [Securing WordPress](/docs/guides/how-to-secure-wordpress/): Advice on securing WordPress through HTTPS, using a secure password, changing the admin username, and more. - [WordPress Themes](https://wordpress.org/themes/#): A collection of *thousands* of WordPress themes. -- [Marketplace Apps Repository](https://github.com/linode-solutions/marketplace-apps): Review the deployment Ansible playbooks. +- [Marketplace Apps Repository](https://github.com/akamai-compute-marketplace/marketplace-apps): Review the deployment Ansible playbooks. {{% content "marketplace-update-note-shortguide" %}}