|
| 1 | +--- |
| 2 | +layout: docwithnav |
| 3 | +title: Installing ThingsBoard PE from AWS Marketplace |
| 4 | +description: Installing ThingsBoard PE from AWS Marketplace |
| 5 | + |
| 6 | +--- |
| 7 | + |
| 8 | +This guide describes how to install ThingsBoard Professional Edition from AWS Marketplace. |
| 9 | +Using this guide you will install [BYOL](https://docs.aws.amazon.com/marketplace/latest/userguide/pricing.html#ami-pricing-models) version of the product. |
| 10 | +Basically, you get the license directly from ThingsBoard, Inc, but purchase corresponding server instances and infrastructure from AWS. |
| 11 | + |
| 12 | +* TOC |
| 13 | +{:toc} |
| 14 | + |
| 15 | +### Prerequisites |
| 16 | + |
| 17 | +- Active [Amazon AWS](https://aws.amazon.com/){:target="_blank"} account |
| 18 | + |
| 19 | +### Step 1. Subscribe to ThingsBoard PE BYOL |
| 20 | + |
| 21 | +Open [ThingsBoard Professional Edition BYOL](https://aws.amazon.com/marketplace/pp/B07V8S6JLG) product page on [AWS Marketplace](https://aws.amazon.com/marketplace). |
| 22 | + |
| 23 | +- Click the **Continue to Subscribe** button |
| 24 | + |
| 25 | +### Step 2. General configuration |
| 26 | + |
| 27 | +- Review and Accept all Terms and Conditions. Click the "Accept Terms" button. |
| 28 | + |
| 29 | +- Leave Fulfillment Option and Software Version as-is. |
| 30 | + |
| 31 | +- Select the region from the list of available AWS regions. |
| 32 | + |
| 33 | +- Click the **Continue to Launch** button |
| 34 | + |
| 35 | +### Step 3. Launch your ThingsBoard PE instance |
| 36 | + |
| 37 | +#### Step 3.1. Choose your Region |
| 38 | + |
| 39 | +Make sure you review the usage instructions. It is always a good idea to copy them to a safe place. |
| 40 | + |
| 41 | +#### Step 3.2. Choose your EC2 Instance Type |
| 42 | + |
| 43 | +You can optionally change your EC2 Instance Type, VPC and Subnet. This step is usually for advanced AWS EC2 users. |
| 44 | + |
| 45 | +#### Step 3.3. Configure Security Group Settings |
| 46 | + |
| 47 | +Make sure you create new Security Group based on seller settings. |
| 48 | + |
| 49 | +- Click the **Create New Based on Seller Settings** button |
| 50 | + |
| 51 | + |
| 52 | + |
| 53 | +Populate necessary Security Group name and details and save new group |
| 54 | + |
| 55 | + |
| 56 | + |
| 57 | +Click the "Save" button. |
| 58 | + |
| 59 | +#### Step 3.4. Configure Key Pair Settings |
| 60 | + |
| 61 | +You can optionally select different or create new Key Pair for your instance. |
| 62 | +Make sure you have access to the key file before you proceed. |
| 63 | +We will use the key file later in this guide. |
| 64 | + |
| 65 | +#### Step 3.5. Launch your ThingsBoard PE Instance |
| 66 | + |
| 67 | +Finally, click the "Launch" button. |
| 68 | + |
| 69 | + |
| 70 | + |
| 71 | +#### Step 3.6. Open EC2 console |
| 72 | + |
| 73 | +Once Launch is complete, you can navigate to EC2 console to find out the Public IP address of the newly created instance. |
| 74 | + |
| 75 | + |
| 76 | + |
| 77 | +#### Step 3.7. Obtain your Public IP and EC2 Instance ID |
| 78 | + |
| 79 | +In AWS EC2 console you need to wait while instance state will be changes to **running** and all Status checks will be finished. |
| 80 | + |
| 81 | + |
| 82 | + |
| 83 | +On the image above example instance has this Public DNS name |
| 84 | + |
| 85 | +- **ec2-18-197-23-51.eu-central-1.compute-1.amazonaws.com** |
| 86 | + |
| 87 | +Instance ID |
| 88 | + |
| 89 | +- **i-032b8bbf297987458** |
| 90 | + |
| 91 | +Please save your Instance ID and Public DNS name to a safe place. We will use them later in this guide. |
| 92 | + |
| 93 | +### Step 4. Obtain your license secret |
| 94 | + |
| 95 | +In order to activate your ThingsBoard instance you will need to get the license secret. |
| 96 | +ThingsBoard Licenses are managed by [ThingsBoard License Portal](https://license.thingsboard.io/signup). |
| 97 | + |
| 98 | +Please register on [ThingsBoard License Portal](https://license.thingsboard.io/signup) to get your license. |
| 99 | +See [How-to get pay-as-you-go subscription](https://www.youtube.com/watch?v=dK-QDFGxWek){:target="_blank"} or [How-to get perpetual license](https://www.youtube.com/watch?v=GPe0lHolWek){:target="_blank"} for more details. |
| 100 | + |
| 101 | +Please save your license secret to a safe place. We will use them later in this guide. |
| 102 | + |
| 103 | +### Step 5. Configure your license secret |
| 104 | + |
| 105 | +Once you get the license secret, you should put it to the thingsboard configuration file. |
| 106 | + |
| 107 | +#### Step 5.1. Connect to your Thingsboard Instance over SSH |
| 108 | + |
| 109 | +Please use the official guides: |
| 110 | + |
| 111 | + * [Connecting to Your Linux Instance from Windows Using PuTTY](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/putty.html) - for Windows users; |
| 112 | + * [Connecting to Your Linux Instance Using SSH](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AccessingInstancesLinux.html) - For Linux/Mac users. |
| 113 | + |
| 114 | +Note: You will need to use instance Public DNS name (see [Step 3.7](/docs/user-guide/install/pe/aws/#step-37-obtain-your-public-ip-and-ec2-instance-id)) and the key file (see [Step 3.4](/docs/user-guide/install/pe/aws/#step-34-configure-key-pair-settings)) |
| 115 | + |
| 116 | +#### Step 5.2. Put License Secret to thingsboard configuration file |
| 117 | + |
| 118 | +Open the file for editing using the following command: |
| 119 | + |
| 120 | +```bash |
| 121 | +sudo nano /etc/thingsboard/conf/thingsboard.conf |
| 122 | +``` |
| 123 | +{: .copy-code} |
| 124 | + |
| 125 | +Locate the following configuration block: |
| 126 | + |
| 127 | +```bash |
| 128 | +# License secret obtained from ThingsBoard License Portal (https://license.thingsboard.io) |
| 129 | +# UNCOMMENT NEXT LINE AND PUT YOUR LICENSE SECRET: |
| 130 | +# export TB_LICENSE_SECRET= |
| 131 | +``` |
| 132 | + |
| 133 | +and put your license secret. Please don't forget to uncomment the export statement. See example below: |
| 134 | + |
| 135 | +```bash |
| 136 | +# License secret obtained from ThingsBoard License Portal (https://license.thingsboard.io) |
| 137 | +# UNCOMMENT NEXT LINE AND PUT YOUR LICENSE SECRET: |
| 138 | +export TB_LICENSE_SECRET=YOUR_LICENSE_SECRET_HERE |
| 139 | +``` |
| 140 | + |
| 141 | +### Step 6. Launch ThingsBoard service |
| 142 | + |
| 143 | +Execute the following command to start ThingsBoard: |
| 144 | + |
| 145 | +```bash |
| 146 | +sudo service thingsboard start |
| 147 | +``` |
| 148 | +{: .copy-code} |
| 149 | + |
| 150 | +{% capture 90-sec-ui %} |
| 151 | +Please allow up to 120 seconds for the Web UI to start. This is applicable only for slow machines with 1-2 CPUs or 1-2 GB RAM.{% endcapture %} |
| 152 | +{% include templates/info-banner.md content=90-sec-ui %} |
| 153 | + |
| 154 | +### Step 7. Connect to Thingsboard UI |
| 155 | + |
| 156 | +Now you can open this link in your browser: |
| 157 | + |
| 158 | +- http://PUBLIC_DNS_NAME/login |
| 159 | + |
| 160 | +In this example: |
| 161 | + |
| 162 | +- http://ec2-18-197-23-51.eu-central-1.compute-1.amazonaws.com/login |
| 163 | + |
| 164 | +Use this login to connect as system Administrator |
| 165 | + |
| 166 | + |
| 167 | + |
| 168 | +Default password for System Administrator is Instance ID (see [Step 3.7](/docs/user-guide/install/pe/aws/#step-37-obtain-your-public-ip-and-ec2-instance-id)). In this example: |
| 169 | + |
| 170 | +- **i-032b8bbf297987458** |
| 171 | + |
| 172 | +Now you can proceed to the next steps. |
| 173 | + |
| 174 | +### Post-installation steps |
| 175 | + |
| 176 | +**Configure HAProxy to enable HTTPS** |
| 177 | + |
| 178 | + * Step 1. Assign valid domain name system (DNS) record to your instance external IP address. |
| 179 | + * Step 2. Connect to your instance using SSH or PuTTY using instructions from the previous questions above. |
| 180 | + * Step 3. Execute the following commands: |
| 181 | + ```bash |
| 182 | + sudo certbot-certonly --domain smth.yourcompany.com --email [email protected] |
| 183 | + sudo haproxy-refresh |
| 184 | + ``` |
| 185 | + where **smth.yourcompany.com** is your DNS name from the second step |
| 186 | + and **[email protected]** is your email to get notifications from [certbot](https://certbot.eff.org/). |
| 187 | + |
| 188 | +### Frequently Asked Questions |
| 189 | + |
| 190 | + |
| 191 | +**How can I enable free trial?** |
| 192 | + |
| 193 | +Customer may still use <a href="https://cloud.thingsboard.io" target="blank">ThingsBoard Professional Edition Live Demo</a> for that. |
| 194 | +30 days of seamless experience and the newest features, except white-labeling, from the latest source code! |
| 195 | + |
| 196 | +**Note:** Live Demo is a shared environment with hardware and software limitations. |
| 197 | +It is introduced to host multiple trial tenants on the same server instance(s). |
| 198 | +<br/><br/> |
| 199 | + |
| 200 | +**What is the Total Cost of Ownership (TCO) for my TB PE instance?** |
| 201 | + |
| 202 | +<p>The typical total cost of ownership consists of:</p> |
| 203 | +<ul> |
| 204 | + <li>TB License fee - see <a href="/pricing">pricing</a></li> |
| 205 | + <li>AWS EC2 instance price - we believe <a href="https://www.ec2instances.info/">ec2instances.info</a> is a convenient resource to compare prices.</li> |
| 206 | + <li>Additional EC2 costs for network traffic, disk space and other optional services (Cloud Watch or similar)</li> |
| 207 | +</ul> |
| 208 | +<p>Example A: The price for ThingsBoard PE instance with Maker subscription plan based on t2.micro with 20 GB disk will cost approximately $20.5 per month:</p> |
| 209 | +<ul> |
| 210 | + <li>$10.00 for monthly ThingsBoard PE Maker subscription fee</li> |
| 211 | + <li>$8.468 for 1 month of t2.micro usage</li> |
| 212 | + <li>$2.0 for 20 GB of EBS volume per month</li> |
| 213 | +</ul> |
| 214 | +<p>Example B: The price for ThingsBoard PE instance with Prototype subscription plan based on t2.medium with 100 GB disk will cost approximately $142.872 per month:</p> |
| 215 | +<ul> |
| 216 | + <li>$99.00 for monthly ThingsBoard PE Prototype subscription fee</li> |
| 217 | + <li>$33.872 for 1 month of t2.medium usage</li> |
| 218 | + <li>$10.0 for 100 GB of EBS volume per month</li> |
| 219 | +</ul> |
| 220 | +<p>All prices are in USD.</p> |
| 221 | + |
| 222 | +<br/> |
| 223 | + |
| 224 | + |
| 225 | +**How to connect to my new ThingsBoard PE instance using SSH?** |
| 226 | + |
| 227 | +See <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AccessingInstancesLinux.html">official documentation page</a> for more details. |
| 228 | +<br/><br/> |
| 229 | + |
| 230 | +**How to connect to my new ThingsBoard PE instance using PuTTY?** |
| 231 | + |
| 232 | +See <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/putty.html">official documentation page</a> for more details. |
| 233 | +<br/><br/> |
| 234 | + |
| 235 | +**How to enable HTTPS?** |
| 236 | + |
| 237 | +See <a href="/docs/user-guide/install/pe/aws/#post-installation-steps">Post-installation steps</a> |
| 238 | +<br/><br/> |
| 239 | + |
| 240 | +**How do I configure my TB PE instance?** |
| 241 | + |
| 242 | +See <a href="/docs/user-guide/install/config/">official documentation page</a> for more details. |
| 243 | + |
| 244 | +<br/> |
| 245 | + |
| 246 | +**How do I get software updates for my TB PE instance?** |
| 247 | + |
| 248 | +You will receive an email notification about new software versions once it becomes available. |
| 249 | +This email notification will contain a link to <a href="/docs/user-guide/install/aws-marketplace-pe-upgrade/">official documentation page</a> with the upgrade instructions. |
| 250 | +<br/><br/> |
| 251 | + |
| 252 | +**How do I backup my database?** |
| 253 | +Depending on your instance type and configuration, ThingsBoard may store data in SQL or NoSQL databases. |
| 254 | +ThingsBoard may also store data using hybrid database mode. |
| 255 | +Please review <a href="/docs/reference/#sql-vs-nosql-vs-hybrid-database-approach">architecture docs</a> for more info on available database types. |
| 256 | +Once you figure out the database type(s) you are using in your instance, you can review official <a href="https://www.postgresql.org/docs/9.1/backup.html">PostgreSQL</a> |
| 257 | +or <a href="https://docs.datastax.com/en/cassandra/3.0/cassandra/operations/opsBackupRestore.html">Cassandra</a> documentation. |
| 258 | +There is also planty of docs and tools in the web how you can backup and restore your DB. |
| 259 | +<br/><br/> |
| 260 | + |
| 261 | +**How do I upgrade my instance type?** |
| 262 | + |
| 263 | +See official License Server <a href="/products/license-server/">documentation page</a> for more details. |
| 264 | +<br/><br/> |
| 265 | + |
| 266 | +**Where is my ThingsBoard instance logs?** |
| 267 | + |
| 268 | +ThingsBoard logs are stored in the <i>/var/log/thingsboard</i> folder. |
| 269 | +See <a href="/docs/user-guide/install/config/#logging">configuration page</a> to find out how to configure logging levels. |
| 270 | +<br/><br/> |
| 271 | + |
| 272 | +**How do I get professional support?** |
| 273 | + |
| 274 | +Please review ThingsBoard professional <a href="/docs/services/support/">support plans</a> and <a href="/docs/contact-us/">contact us</a>. |
| 275 | +<br/><br/> |
| 276 | + |
| 277 | +### Next steps |
| 278 | + |
| 279 | +{% assign currentGuide = "InstallationGuides" %}{% include templates/guides-banner.md %} |
0 commit comments