From 2e8b4e6b2564663f32adde6c321c1f4c31008913 Mon Sep 17 00:00:00 2001 From: denniskuijs Date: Wed, 24 Dec 2025 14:37:33 +0100 Subject: [PATCH 1/2] Update AWS Marketplace docs --- docs/user-guide/deploying/aws-marketplace.md | 12 ++++++------ .../user-guide/deploying/aws-marketplace.md | 12 ++++++------ 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/user-guide/deploying/aws-marketplace.md b/docs/user-guide/deploying/aws-marketplace.md index dc3e7166..0b482418 100644 --- a/docs/user-guide/deploying/aws-marketplace.md +++ b/docs/user-guide/deploying/aws-marketplace.md @@ -64,7 +64,7 @@ After subscribing on OpenRemote via the AWS Marketplace, you can start configuri ::: -* `Storage` - You can specify the amount of block storage to provision for this OpenRemote instance, with options of `8GB`, `16GB`, `32GB`, `48GB` and `64GB`. +* `Storage` - You can specify the amount of block storage to provision for this OpenRemote instance, with options of `32GB`, `48GB` and `64GB`. It is possible to expand the volume after instance creation, but a reboot will be required. * `Key pair` - Choose a `key pair` for this OpenRemote instance. With the selected `key pair` you can `SSH` into the machine. @@ -114,7 +114,7 @@ The latest version of OpenRemote will be installed. Click [here](https://github. After the `EC2` instance is successfully provisioned, the `CREATE_COMPLETE` status will appear on the `CloudFormation` page. -To start using OpenRemote, either visit the `hostname` you specified during configuration or navigate to the `EC2` page and locate the instance named `%AWS-STACKNAME%-AWS Marketplace` (make sure to replace `%AWS-STACKNAME%` with the stack name you have provided during configuration) and look for the `Public IPv4 address`. +To start using OpenRemote, either visit the `hostname` you specified during configuration or navigate to the `EC2` page and locate the instance named `OpenRemote` and look for the `Public IPv4 address`. You can also view the `IPv4` address by clicking on the `Outputs` section of the `CloudFormation` stack. @@ -122,12 +122,12 @@ You can also view the `IPv4` address by clicking on the `Outputs` section of the You can access the `EC2` instance via `SSH` by following the steps below. - Navigate to the `EC2` page, then click on `Security Groups` located under the `Network & Security` section on the left-hand menu. -- Locate the security group named `%AWS-STACKNAME%-or-ssh-whitelist` (make sure to replace `%AWS-STACKNAME%` with the stack name you specified during configuration) and click on it. +- Locate the security group named `-or-ssh-whitelist` (make sure to replace `` with the stack name you specified during configuration) and click on it. - In the `Inbound rules` section, click the `Edit inbound rules` button. - Click the `Add rule` button to insert a new entry in the `Inbound rules` section. - Set the `type` to `SSH`, and enter your `ISP IP address` in the `Source` field. You can find your `IP address` [here](https://whatsmyip.com/). - Click the `Save rules` button to apply the changes. -- You've now whitelisted your `IP address` to access the `EC2` instance. To connect, open your terminal and run the following command: `ssh ec2-user@%EC2PublicIP%` (make sure to replace `%EC2PublicIP%` with the instance's actual `IPv4` address or the `hostname` you have provided during configuration) +- You've now whitelisted your `IP address` to access the `EC2` instance. To connect, open your terminal and run the following command: `ssh ec2-user@` (make sure to replace `` with the instance's actual `IPv4` address or the `hostname` you have provided during configuration) :::note @@ -136,7 +136,7 @@ To `SSH` into the machine, ensure that your `key pair` is saved in the `.ssh` di ::: ## Where can I find the installation files? -The installation files are located in the `/openremote` folder. You can navigate to it using the command `cd /openremote`. The data from the platform is stored in persistent `docker` volumes, located in the `/var/lib/docker/volumes` directory. +The installation files are located in the `/home/ec2-user/` folder. You can navigate to it using the command `cd /home/ec2-user/`. The data from the platform is stored in persistent `docker` volumes, located in the `/var/lib/docker/volumes` directory. ## Unsubscribe from the AWS Marketplace To stop using OpenRemote from the AWS Marketplace, you can unsubscribe by following the steps below. @@ -151,4 +151,4 @@ To stop using OpenRemote from the AWS Marketplace, you can unsubscribe by follow To cancel the subscription, you must first delete the OpenRemote stack created with it. -::: \ No newline at end of file +::: diff --git a/versioned_docs/version-1.12.0/user-guide/deploying/aws-marketplace.md b/versioned_docs/version-1.12.0/user-guide/deploying/aws-marketplace.md index dc3e7166..0b482418 100644 --- a/versioned_docs/version-1.12.0/user-guide/deploying/aws-marketplace.md +++ b/versioned_docs/version-1.12.0/user-guide/deploying/aws-marketplace.md @@ -64,7 +64,7 @@ After subscribing on OpenRemote via the AWS Marketplace, you can start configuri ::: -* `Storage` - You can specify the amount of block storage to provision for this OpenRemote instance, with options of `8GB`, `16GB`, `32GB`, `48GB` and `64GB`. +* `Storage` - You can specify the amount of block storage to provision for this OpenRemote instance, with options of `32GB`, `48GB` and `64GB`. It is possible to expand the volume after instance creation, but a reboot will be required. * `Key pair` - Choose a `key pair` for this OpenRemote instance. With the selected `key pair` you can `SSH` into the machine. @@ -114,7 +114,7 @@ The latest version of OpenRemote will be installed. Click [here](https://github. After the `EC2` instance is successfully provisioned, the `CREATE_COMPLETE` status will appear on the `CloudFormation` page. -To start using OpenRemote, either visit the `hostname` you specified during configuration or navigate to the `EC2` page and locate the instance named `%AWS-STACKNAME%-AWS Marketplace` (make sure to replace `%AWS-STACKNAME%` with the stack name you have provided during configuration) and look for the `Public IPv4 address`. +To start using OpenRemote, either visit the `hostname` you specified during configuration or navigate to the `EC2` page and locate the instance named `OpenRemote` and look for the `Public IPv4 address`. You can also view the `IPv4` address by clicking on the `Outputs` section of the `CloudFormation` stack. @@ -122,12 +122,12 @@ You can also view the `IPv4` address by clicking on the `Outputs` section of the You can access the `EC2` instance via `SSH` by following the steps below. - Navigate to the `EC2` page, then click on `Security Groups` located under the `Network & Security` section on the left-hand menu. -- Locate the security group named `%AWS-STACKNAME%-or-ssh-whitelist` (make sure to replace `%AWS-STACKNAME%` with the stack name you specified during configuration) and click on it. +- Locate the security group named `-or-ssh-whitelist` (make sure to replace `` with the stack name you specified during configuration) and click on it. - In the `Inbound rules` section, click the `Edit inbound rules` button. - Click the `Add rule` button to insert a new entry in the `Inbound rules` section. - Set the `type` to `SSH`, and enter your `ISP IP address` in the `Source` field. You can find your `IP address` [here](https://whatsmyip.com/). - Click the `Save rules` button to apply the changes. -- You've now whitelisted your `IP address` to access the `EC2` instance. To connect, open your terminal and run the following command: `ssh ec2-user@%EC2PublicIP%` (make sure to replace `%EC2PublicIP%` with the instance's actual `IPv4` address or the `hostname` you have provided during configuration) +- You've now whitelisted your `IP address` to access the `EC2` instance. To connect, open your terminal and run the following command: `ssh ec2-user@` (make sure to replace `` with the instance's actual `IPv4` address or the `hostname` you have provided during configuration) :::note @@ -136,7 +136,7 @@ To `SSH` into the machine, ensure that your `key pair` is saved in the `.ssh` di ::: ## Where can I find the installation files? -The installation files are located in the `/openremote` folder. You can navigate to it using the command `cd /openremote`. The data from the platform is stored in persistent `docker` volumes, located in the `/var/lib/docker/volumes` directory. +The installation files are located in the `/home/ec2-user/` folder. You can navigate to it using the command `cd /home/ec2-user/`. The data from the platform is stored in persistent `docker` volumes, located in the `/var/lib/docker/volumes` directory. ## Unsubscribe from the AWS Marketplace To stop using OpenRemote from the AWS Marketplace, you can unsubscribe by following the steps below. @@ -151,4 +151,4 @@ To stop using OpenRemote from the AWS Marketplace, you can unsubscribe by follow To cancel the subscription, you must first delete the OpenRemote stack created with it. -::: \ No newline at end of file +::: From f7f217fff5ffeaae717858aee7b4cb70272eda93 Mon Sep 17 00:00:00 2001 From: denniskuijs Date: Wed, 24 Dec 2025 15:57:57 +0100 Subject: [PATCH 2/2] Update docs --- docs/user-guide/deploying/aws-marketplace.md | 108 ++++++++++-------- .../user-guide/deploying/aws-marketplace.md | 108 ++++++++++-------- 2 files changed, 122 insertions(+), 94 deletions(-) diff --git a/docs/user-guide/deploying/aws-marketplace.md b/docs/user-guide/deploying/aws-marketplace.md index 0b482418..19bec02d 100644 --- a/docs/user-guide/deploying/aws-marketplace.md +++ b/docs/user-guide/deploying/aws-marketplace.md @@ -5,7 +5,7 @@ sidebar_position: 4 # AWS Marketplace This guide explains how to provision/configure OpenRemote via the AWS Marketplace. -The `CloudFormation` template can be found at [cloudformation-aws-marketplace.yml](https://github.com/openremote/openremote/blob/master/.ci_cd/aws/cloudformation-aws-marketplace.yml). +The CloudFormation template can be found at [cloudformation-aws-marketplace.yml](https://github.com/openremote/openremote/blob/master/.ci_cd/aws/cloudformation-aws-marketplace.yml). This product requires an internet connection to deploy properly. The following packages are downloaded on deployment: * `Docker` @@ -17,26 +17,26 @@ This product requires an internet connection to deploy properly. The following p ## Subscribe to the AWS Marketplace To use OpenRemote through the AWS Marketplace, you need an active subscription. Follow the steps below to subscribe. -- Search for OpenRemote on the [AWS Marketplace](https://aws.amazon.com/marketplace/search/results?searchTerms=openremote) and click on the listing. -- Click the `View purchase options` button. -- Accept the EULA by selecting `Accept Terms`. -- You are now subscribed on OpenRemote via the AWS Marketplace. Processing the subscription will take a few minutes. Once completed, the `Continue to Configuration` button becomes available. -- Click `Continue to Configuration` to start configuring OpenRemote. -- Choose a template version (the latest version is selected by default) and select your preferred AWS `region` for deployment. -- Click `Continue to Launch` after making your selections. -- Review your selections and click `Launch` to proceed. You will be redirected to the AWS `CloudFormation` page. -- On the AWS `CloudFormation` page, click `Next` to continue. +- Search for OpenRemote on the [AWS Marketplace](https://aws.amazon.com/marketplace/search/results?searchTerms=openremote), or click directly on the [listing](https://aws.amazon.com/marketplace/pp/prodview-xfrwnrs7bvxlw). +- Click the 'View purchase options' button. +- Accept the EULA by selecting 'Accept Terms'. +- You are now subscribed on OpenRemote via the AWS Marketplace. Processing the subscription will take a few minutes. Once completed, the 'Continue to Configuration' button becomes available. +- Click 'Continue to Configuration' to start configuring OpenRemote. +- Choose a template version (the latest version is selected by default) and select your preferred AWS region for deployment. +- Click 'Continue' to launch after making your selections. +- Review your selections and click 'Launch' to proceed. You will be redirected to the AWS CloudFormation page. +- On the AWS CloudFormation page, click 'Next' to continue. ## Instance Configuration After subscribing on OpenRemote via the AWS Marketplace, you can start configuring it. Below, you will find a detailed description of each parameter available in the template. -* `Stack name` - You need to specify an unique `CloudFormation` stack name for this deployment. - The `stack name` must contain only letters (a-z, A-Z), numbers (0-9), and hyphens (-) and start with a letter. Max 128 characters. +* Stack name - You need to specify a unique CloudFormation stack name for this deployment. + The stack name must contain only letters (a-z, A-Z), numbers (0-9), and hyphens (-) and start with a letter. Max 128 characters. -* `Hostname` - You can specify the fully qualified domain name (`FQDN`) you want to use for this OpenRemote instance. - If no value is provided, you can access OpenRemote using the public `IPv4` address of the `EC2` instance. +* Hostname - You can specify the fully qualified domain name (FQDN) you want to use for this OpenRemote instance. + If no value is provided, you can access OpenRemote using the public IPv4 address of the EC2 instance. -* `Instance Type` - You can choose from the following `t4g` and `m6g` instance types: +* Instance type - You can choose from the following t4g and m6g instance types: - `t4g.small` - vCPU: 2 - Memory: 2GB @@ -53,10 +53,10 @@ After subscribing on OpenRemote via the AWS Marketplace, you can start configuri - vCPU: 4 - Memory: 16GB - Prices vary based on the selected instance. All instances are using the `ARM` architecture. + Prices vary based on the selected instance. All instances are using the ARM architecture. For detailed pricing information, visit the pricing pages for [t4g](https://aws.amazon.com/ec2/instance-types/t4/) and [m6g](https://aws.amazon.com/ec2/instance-types/m6g/). -* `Amazon Machine Image` - This is the Amazon Machine Image (`AMI`) that is used by the `EC2` instance. +* Amazon Machine Image - This is the Amazon Machine Image (AMI) that is used by the EC2 instance. :::danger @@ -64,47 +64,47 @@ After subscribing on OpenRemote via the AWS Marketplace, you can start configuri ::: -* `Storage` - You can specify the amount of block storage to provision for this OpenRemote instance, with options of `32GB`, `48GB` and `64GB`. +* Storage - You can specify the amount of block storage to provision for this OpenRemote instance, with options of `32GB`, `48GB` and `64GB`. It is possible to expand the volume after instance creation, but a reboot will be required. -* `Key pair` - Choose a `key pair` for this OpenRemote instance. With the selected `key pair` you can `SSH` into the machine. - You can only select a `key pair` that was created in the **same** region as where you want to deploy the OpenRemote instance. +* Key pair - Choose a key pair for this OpenRemote instance. With the selected key pair you can SSH into the machine. + You can only select a key pair that was created in the **same** region as where you want to deploy the OpenRemote instance. :::tip - To create a new `key pair`, follow the steps provided [here](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html). + To create a new key pair, follow the steps provided [here](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html). ::: :::danger - After creating the `key pair`, you receive a private key. + After creating the key pair, you receive a private key. - Make sure to save this file on a secure location, as you will not be able to `SSH` into the machine without it. + Make sure to save this file on a secure location, as you will not be able to SSH into the machine without it. If you accidentally lose your key, follow the steps provided [here](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/replacing-key-pair.html) to recover access to your instance. ::: -* `Elastic IP` - You can choose whether to assign an `Elastic IP` to this OpenRemote instance. Enabling this option ensures that your `IPv4` address remains the same after `stopping` the instance. +* Elastic IP - You can choose whether to assign an Elastic IP to this OpenRemote instance. Enabling this option ensures that your IPv4 address remains the same after stopping the instance. Additional charges may apply, visit the pricing page [here](https://aws.amazon.com/vpc/pricing/). ## OpenRemote Configuration (Optional) -* `Password` - You can override the default password (`secret`) by providing a new password. +* Password - You can override the default password by providing a new password. There are no specific requirements for this password. If you do not provide one, you can log in to the manager using the default credentials (username `admin` and password `secret`). ## E-mail Configuration (Optional) -* `SMTP Hostname` - You can specify the `hostname` that will be used for sending e-mails. (e.g. mail.example.com). -* `SMTP Username` - You can specify the username for authenticating with the `SMTP` server. In most cases this is the e-mail address of the sending account. -* `SMTP Password` - You can specify the password for authenticating with the `SMTP` server. -* `SMTP Sending Address` - You can specify the e-mail address that will be used as the sending address. The e-mail address is visible for the receivers. (e.g. no-reply@example.com). +* SMTP Hostname - You can specify the hostname that will be used for sending e-mails. (e.g. mail.example.com). +* SMTP Username - You can specify the username for authenticating with the SMTP server. In most cases this is the e-mail address of the sending account. +* SMTP Password - You can specify the password for authenticating with the SMTP server. +* SMTP From Address - You can specify the e-mail address that will be used as the sending address. The e-mail address is visible for the receivers. (e.g. no-reply@example.com). ## OpenRemote installation -Once you've entered all the required details, click the `Next` button at the bottom of the page. You’ll be taken to a configuration page where you can configure various stack options. There’s no need to make any changes here, simply click `Next` again. -On the final page, you'll see a summary of your deployment. Review the information, then click the `Submit` button at the bottom to confirm and proceed. +Once you've entered all the required details, click the 'Next' button at the bottom of the page. You’ll be taken to a configuration page where you can configure various stack options. There’s no need to make any changes here, simply click 'Next' again. +On the final page, you'll see a summary of your deployment. Review the information, then click the 'Submit' button at the bottom to confirm and proceed. -Amazon is provisioning the `EC2` instance using the provided `CloudFormation` template, this process takes around `5` to `10` minutes. You can monitor the progress by regularly refreshing the page using the refresh button located on the right-hand side. +Amazon is provisioning the EC2 instance using the provided CloudFormation template, this process takes around 5 to 10 minutes. You can monitor the progress by regularly refreshing the page using the refresh button located on the right-hand side. :::note @@ -112,40 +112,54 @@ The latest version of OpenRemote will be installed. Click [here](https://github. ::: -After the `EC2` instance is successfully provisioned, the `CREATE_COMPLETE` status will appear on the `CloudFormation` page. +After the EC2 instance is successfully provisioned, the `CREATE_COMPLETE` status will appear on the CloudFormation page. -To start using OpenRemote, either visit the `hostname` you specified during configuration or navigate to the `EC2` page and locate the instance named `OpenRemote` and look for the `Public IPv4 address`. +To start using OpenRemote, either visit the hostname you specified during configuration or navigate to the EC2 page and locate the instance named `OpenRemote` and look for the IPv4 address. +You can also view the IPv4 address by clicking on the outputs section of the CloudFormation stack. -You can also view the `IPv4` address by clicking on the `Outputs` section of the `CloudFormation` stack. +:::warning +If you have configured a custom hostname, make sure to add an A record pointing to the instance's IPv4 address in your DNS. +::: ## How can I access the EC2 instance? -You can access the `EC2` instance via `SSH` by following the steps below. +You can access the EC2 instance via SSH by following the steps below. + +- Navigate to the EC2 page, then click on 'Security Groups' located under the 'Network & Security' section on the left-hand menu. +- Locate the security group named `-or-ssh-whitelist` (make sure to replace `` with the stack name you specified during configuration) and click on it. +- In the inbound rules section, click the 'Edit inbound rules' button. +- Click the 'Add rule' button to insert a new entry in the inbound rules section. +- Set the `type` to `SSH`, and enter your IP address in the source field. You can find your IP address [here](https://whatsmyip.com/). +- Click the 'Save rules' button to apply the changes. +- You've now whitelisted your IP address to access the EC2 instance. To connect, open your terminal and run the following command: -- Navigate to the `EC2` page, then click on `Security Groups` located under the `Network & Security` section on the left-hand menu. -- Locate the security group named `-or-ssh-whitelist` (make sure to replace `` with the stack name you specified during configuration) and click on it. -- In the `Inbound rules` section, click the `Edit inbound rules` button. -- Click the `Add rule` button to insert a new entry in the `Inbound rules` section. -- Set the `type` to `SSH`, and enter your `ISP IP address` in the `Source` field. You can find your `IP address` [here](https://whatsmyip.com/). -- Click the `Save rules` button to apply the changes. -- You've now whitelisted your `IP address` to access the `EC2` instance. To connect, open your terminal and run the following command: `ssh ec2-user@` (make sure to replace `` with the instance's actual `IPv4` address or the `hostname` you have provided during configuration) +```bash +ssh ec2-user@ +``` +Make sure to replace `` with the instance's IPv4 address or the hostname you have provided during configuration. :::note -To `SSH` into the machine, ensure that your `key pair` is saved in the `.ssh` directory. +To SSH into the machine, ensure that your key pair is saved in the `.ssh` directory. ::: ## Where can I find the installation files? -The installation files are located in the `/home/ec2-user/` folder. You can navigate to it using the command `cd /home/ec2-user/`. The data from the platform is stored in persistent `docker` volumes, located in the `/var/lib/docker/volumes` directory. +The installation files are located in the `/home/ec2-user/` directory. You can navigate to it using the following command: + +```bash +cd /home/ec2-user/ +``` + +The data from the platform is stored in persistent `Docker` volumes, located in the `/var/lib/docker/volumes` directory. ## Unsubscribe from the AWS Marketplace To stop using OpenRemote from the AWS Marketplace, you can unsubscribe by following the steps below. - Visit the AWS Marketplace subscriptions page by clicking [here](https://us-east-1.console.aws.amazon.com/marketplace/home#/subscriptions). - Find the OpenRemote subscription in the list and click on it. -- Click the `Actions` button, then select `Cancel Subscription`. +- Click the 'Actions' button, then select 'Cancel Subscription'. - A modal pops up asking you to confirm the cancellation of the subscription. -- To confirm cancellation, type `confirm` in the designated input field and click the `Yes, cancel subscription` button. +- To confirm cancellation, type 'confirm' in the designated input field and click the 'Yes, cancel subscription' button. :::note diff --git a/versioned_docs/version-1.12.0/user-guide/deploying/aws-marketplace.md b/versioned_docs/version-1.12.0/user-guide/deploying/aws-marketplace.md index 0b482418..19bec02d 100644 --- a/versioned_docs/version-1.12.0/user-guide/deploying/aws-marketplace.md +++ b/versioned_docs/version-1.12.0/user-guide/deploying/aws-marketplace.md @@ -5,7 +5,7 @@ sidebar_position: 4 # AWS Marketplace This guide explains how to provision/configure OpenRemote via the AWS Marketplace. -The `CloudFormation` template can be found at [cloudformation-aws-marketplace.yml](https://github.com/openremote/openremote/blob/master/.ci_cd/aws/cloudformation-aws-marketplace.yml). +The CloudFormation template can be found at [cloudformation-aws-marketplace.yml](https://github.com/openremote/openremote/blob/master/.ci_cd/aws/cloudformation-aws-marketplace.yml). This product requires an internet connection to deploy properly. The following packages are downloaded on deployment: * `Docker` @@ -17,26 +17,26 @@ This product requires an internet connection to deploy properly. The following p ## Subscribe to the AWS Marketplace To use OpenRemote through the AWS Marketplace, you need an active subscription. Follow the steps below to subscribe. -- Search for OpenRemote on the [AWS Marketplace](https://aws.amazon.com/marketplace/search/results?searchTerms=openremote) and click on the listing. -- Click the `View purchase options` button. -- Accept the EULA by selecting `Accept Terms`. -- You are now subscribed on OpenRemote via the AWS Marketplace. Processing the subscription will take a few minutes. Once completed, the `Continue to Configuration` button becomes available. -- Click `Continue to Configuration` to start configuring OpenRemote. -- Choose a template version (the latest version is selected by default) and select your preferred AWS `region` for deployment. -- Click `Continue to Launch` after making your selections. -- Review your selections and click `Launch` to proceed. You will be redirected to the AWS `CloudFormation` page. -- On the AWS `CloudFormation` page, click `Next` to continue. +- Search for OpenRemote on the [AWS Marketplace](https://aws.amazon.com/marketplace/search/results?searchTerms=openremote), or click directly on the [listing](https://aws.amazon.com/marketplace/pp/prodview-xfrwnrs7bvxlw). +- Click the 'View purchase options' button. +- Accept the EULA by selecting 'Accept Terms'. +- You are now subscribed on OpenRemote via the AWS Marketplace. Processing the subscription will take a few minutes. Once completed, the 'Continue to Configuration' button becomes available. +- Click 'Continue to Configuration' to start configuring OpenRemote. +- Choose a template version (the latest version is selected by default) and select your preferred AWS region for deployment. +- Click 'Continue' to launch after making your selections. +- Review your selections and click 'Launch' to proceed. You will be redirected to the AWS CloudFormation page. +- On the AWS CloudFormation page, click 'Next' to continue. ## Instance Configuration After subscribing on OpenRemote via the AWS Marketplace, you can start configuring it. Below, you will find a detailed description of each parameter available in the template. -* `Stack name` - You need to specify an unique `CloudFormation` stack name for this deployment. - The `stack name` must contain only letters (a-z, A-Z), numbers (0-9), and hyphens (-) and start with a letter. Max 128 characters. +* Stack name - You need to specify a unique CloudFormation stack name for this deployment. + The stack name must contain only letters (a-z, A-Z), numbers (0-9), and hyphens (-) and start with a letter. Max 128 characters. -* `Hostname` - You can specify the fully qualified domain name (`FQDN`) you want to use for this OpenRemote instance. - If no value is provided, you can access OpenRemote using the public `IPv4` address of the `EC2` instance. +* Hostname - You can specify the fully qualified domain name (FQDN) you want to use for this OpenRemote instance. + If no value is provided, you can access OpenRemote using the public IPv4 address of the EC2 instance. -* `Instance Type` - You can choose from the following `t4g` and `m6g` instance types: +* Instance type - You can choose from the following t4g and m6g instance types: - `t4g.small` - vCPU: 2 - Memory: 2GB @@ -53,10 +53,10 @@ After subscribing on OpenRemote via the AWS Marketplace, you can start configuri - vCPU: 4 - Memory: 16GB - Prices vary based on the selected instance. All instances are using the `ARM` architecture. + Prices vary based on the selected instance. All instances are using the ARM architecture. For detailed pricing information, visit the pricing pages for [t4g](https://aws.amazon.com/ec2/instance-types/t4/) and [m6g](https://aws.amazon.com/ec2/instance-types/m6g/). -* `Amazon Machine Image` - This is the Amazon Machine Image (`AMI`) that is used by the `EC2` instance. +* Amazon Machine Image - This is the Amazon Machine Image (AMI) that is used by the EC2 instance. :::danger @@ -64,47 +64,47 @@ After subscribing on OpenRemote via the AWS Marketplace, you can start configuri ::: -* `Storage` - You can specify the amount of block storage to provision for this OpenRemote instance, with options of `32GB`, `48GB` and `64GB`. +* Storage - You can specify the amount of block storage to provision for this OpenRemote instance, with options of `32GB`, `48GB` and `64GB`. It is possible to expand the volume after instance creation, but a reboot will be required. -* `Key pair` - Choose a `key pair` for this OpenRemote instance. With the selected `key pair` you can `SSH` into the machine. - You can only select a `key pair` that was created in the **same** region as where you want to deploy the OpenRemote instance. +* Key pair - Choose a key pair for this OpenRemote instance. With the selected key pair you can SSH into the machine. + You can only select a key pair that was created in the **same** region as where you want to deploy the OpenRemote instance. :::tip - To create a new `key pair`, follow the steps provided [here](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html). + To create a new key pair, follow the steps provided [here](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html). ::: :::danger - After creating the `key pair`, you receive a private key. + After creating the key pair, you receive a private key. - Make sure to save this file on a secure location, as you will not be able to `SSH` into the machine without it. + Make sure to save this file on a secure location, as you will not be able to SSH into the machine without it. If you accidentally lose your key, follow the steps provided [here](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/replacing-key-pair.html) to recover access to your instance. ::: -* `Elastic IP` - You can choose whether to assign an `Elastic IP` to this OpenRemote instance. Enabling this option ensures that your `IPv4` address remains the same after `stopping` the instance. +* Elastic IP - You can choose whether to assign an Elastic IP to this OpenRemote instance. Enabling this option ensures that your IPv4 address remains the same after stopping the instance. Additional charges may apply, visit the pricing page [here](https://aws.amazon.com/vpc/pricing/). ## OpenRemote Configuration (Optional) -* `Password` - You can override the default password (`secret`) by providing a new password. +* Password - You can override the default password by providing a new password. There are no specific requirements for this password. If you do not provide one, you can log in to the manager using the default credentials (username `admin` and password `secret`). ## E-mail Configuration (Optional) -* `SMTP Hostname` - You can specify the `hostname` that will be used for sending e-mails. (e.g. mail.example.com). -* `SMTP Username` - You can specify the username for authenticating with the `SMTP` server. In most cases this is the e-mail address of the sending account. -* `SMTP Password` - You can specify the password for authenticating with the `SMTP` server. -* `SMTP Sending Address` - You can specify the e-mail address that will be used as the sending address. The e-mail address is visible for the receivers. (e.g. no-reply@example.com). +* SMTP Hostname - You can specify the hostname that will be used for sending e-mails. (e.g. mail.example.com). +* SMTP Username - You can specify the username for authenticating with the SMTP server. In most cases this is the e-mail address of the sending account. +* SMTP Password - You can specify the password for authenticating with the SMTP server. +* SMTP From Address - You can specify the e-mail address that will be used as the sending address. The e-mail address is visible for the receivers. (e.g. no-reply@example.com). ## OpenRemote installation -Once you've entered all the required details, click the `Next` button at the bottom of the page. You’ll be taken to a configuration page where you can configure various stack options. There’s no need to make any changes here, simply click `Next` again. -On the final page, you'll see a summary of your deployment. Review the information, then click the `Submit` button at the bottom to confirm and proceed. +Once you've entered all the required details, click the 'Next' button at the bottom of the page. You’ll be taken to a configuration page where you can configure various stack options. There’s no need to make any changes here, simply click 'Next' again. +On the final page, you'll see a summary of your deployment. Review the information, then click the 'Submit' button at the bottom to confirm and proceed. -Amazon is provisioning the `EC2` instance using the provided `CloudFormation` template, this process takes around `5` to `10` minutes. You can monitor the progress by regularly refreshing the page using the refresh button located on the right-hand side. +Amazon is provisioning the EC2 instance using the provided CloudFormation template, this process takes around 5 to 10 minutes. You can monitor the progress by regularly refreshing the page using the refresh button located on the right-hand side. :::note @@ -112,40 +112,54 @@ The latest version of OpenRemote will be installed. Click [here](https://github. ::: -After the `EC2` instance is successfully provisioned, the `CREATE_COMPLETE` status will appear on the `CloudFormation` page. +After the EC2 instance is successfully provisioned, the `CREATE_COMPLETE` status will appear on the CloudFormation page. -To start using OpenRemote, either visit the `hostname` you specified during configuration or navigate to the `EC2` page and locate the instance named `OpenRemote` and look for the `Public IPv4 address`. +To start using OpenRemote, either visit the hostname you specified during configuration or navigate to the EC2 page and locate the instance named `OpenRemote` and look for the IPv4 address. +You can also view the IPv4 address by clicking on the outputs section of the CloudFormation stack. -You can also view the `IPv4` address by clicking on the `Outputs` section of the `CloudFormation` stack. +:::warning +If you have configured a custom hostname, make sure to add an A record pointing to the instance's IPv4 address in your DNS. +::: ## How can I access the EC2 instance? -You can access the `EC2` instance via `SSH` by following the steps below. +You can access the EC2 instance via SSH by following the steps below. + +- Navigate to the EC2 page, then click on 'Security Groups' located under the 'Network & Security' section on the left-hand menu. +- Locate the security group named `-or-ssh-whitelist` (make sure to replace `` with the stack name you specified during configuration) and click on it. +- In the inbound rules section, click the 'Edit inbound rules' button. +- Click the 'Add rule' button to insert a new entry in the inbound rules section. +- Set the `type` to `SSH`, and enter your IP address in the source field. You can find your IP address [here](https://whatsmyip.com/). +- Click the 'Save rules' button to apply the changes. +- You've now whitelisted your IP address to access the EC2 instance. To connect, open your terminal and run the following command: -- Navigate to the `EC2` page, then click on `Security Groups` located under the `Network & Security` section on the left-hand menu. -- Locate the security group named `-or-ssh-whitelist` (make sure to replace `` with the stack name you specified during configuration) and click on it. -- In the `Inbound rules` section, click the `Edit inbound rules` button. -- Click the `Add rule` button to insert a new entry in the `Inbound rules` section. -- Set the `type` to `SSH`, and enter your `ISP IP address` in the `Source` field. You can find your `IP address` [here](https://whatsmyip.com/). -- Click the `Save rules` button to apply the changes. -- You've now whitelisted your `IP address` to access the `EC2` instance. To connect, open your terminal and run the following command: `ssh ec2-user@` (make sure to replace `` with the instance's actual `IPv4` address or the `hostname` you have provided during configuration) +```bash +ssh ec2-user@ +``` +Make sure to replace `` with the instance's IPv4 address or the hostname you have provided during configuration. :::note -To `SSH` into the machine, ensure that your `key pair` is saved in the `.ssh` directory. +To SSH into the machine, ensure that your key pair is saved in the `.ssh` directory. ::: ## Where can I find the installation files? -The installation files are located in the `/home/ec2-user/` folder. You can navigate to it using the command `cd /home/ec2-user/`. The data from the platform is stored in persistent `docker` volumes, located in the `/var/lib/docker/volumes` directory. +The installation files are located in the `/home/ec2-user/` directory. You can navigate to it using the following command: + +```bash +cd /home/ec2-user/ +``` + +The data from the platform is stored in persistent `Docker` volumes, located in the `/var/lib/docker/volumes` directory. ## Unsubscribe from the AWS Marketplace To stop using OpenRemote from the AWS Marketplace, you can unsubscribe by following the steps below. - Visit the AWS Marketplace subscriptions page by clicking [here](https://us-east-1.console.aws.amazon.com/marketplace/home#/subscriptions). - Find the OpenRemote subscription in the list and click on it. -- Click the `Actions` button, then select `Cancel Subscription`. +- Click the 'Actions' button, then select 'Cancel Subscription'. - A modal pops up asking you to confirm the cancellation of the subscription. -- To confirm cancellation, type `confirm` in the designated input field and click the `Yes, cancel subscription` button. +- To confirm cancellation, type 'confirm' in the designated input field and click the 'Yes, cancel subscription' button. :::note