User Manual
Connect using Docker - select operating system
This page guides you through selecting an operating system for your Docker installation, initiating the connection process to link your awaBerry device.
Connect using Docker - select operating system
Summary
This page is the first step in connecting your device to awaBerry using Docker. It allows you to choose the operating system where Docker will be installed. Once you select an operating system, the system will prepare the necessary setup to proceed with the connection.
Connect using Docker - Debian
This page is an essential step in setting up your awaBerry device using Docker on a Debian system. Here, you can download the necessary Docker configuration file and the corresponding license. Additionally, you will find a sequence of command-line instructions that guide you through building, running, and interacting with your new awaBerry Docker container. Follow these steps to prepare your environment and integrate your new device with awaBerry.
Connect using Docker - Mint
This page is your guide to connecting a device using Docker. You'll find options to download essential Docker files and clear instructions to set up the awaBerry Docker image on your computer. This process enables your device to integrate with your awaBerry system, ensuring a smooth setup.
Connect using Docker - Ubuntu
This manual page assists you in establishing a connection to your awaBerry device via Docker on an Ubuntu operating system. It provides straightforward instructions for downloading the essential Docker files and executing the required commands to build and run the awaBerry Docker image.
Page Access
You can access this page by navigating to: /connect_steps_docker
Page Functionalities
This page allows you to select the operating system on which you intend to install Docker for connecting with awaBerry. It features interactive tiles for selection and provides feedback through loading indicators and error messages.
Interactive Elements:
- Operating System Selection Tiles: You will see three distinct tiles, each representing a different operating system. To select an operating system, simply tap or click on the corresponding tile. The selected tile will visually highlight to confirm your choice. Once a selection is made, the system automatically proceeds to the next step.
- Ubuntu (Version: 24.04 LTS): Select this if your system runs Ubuntu.
- Debian (Version: Bookworm): Choose this option for Debian-based systems.
- Linux Mint (Version: 22): Use this if you are running Linux Mint.
- Error Message Display: If any issues occur during the process, a prominent red error message will appear at the top of the page, providing information about what went wrong.
- Loading Indicator: During backend processes (such as creating installation records or checking device limits), a full-screen loading indicator will be displayed to show that the system is actively working.
Scenario Executions
Possible usage steps within this page
These scenarios describe how to successfully use the page to connect your device.
1. Successfully Select Ubuntu and Proceed
This scenario guides you through selecting Ubuntu as your operating system and successfully proceeding to the next connection step.
- Step 1: Open the "Connect using Docker - select operating system" page.
- Step 2: Click or tap on the "Ubuntu" tile.
- Step 3: Observe a loading indicator briefly.
- Step 4: The page automatically transitions to the next step of the awaBerry device connection process.
2. Successfully Select Debian and Proceed
This scenario guides you through selecting Debian as your operating system and successfully proceeding to the next connection step.
- Step 1: Open the "Connect using Docker - select operating system" page.
- Step 2: Click or tap on the "Debian" tile.
- Step 3: Observe a loading indicator briefly.
- Step 4: The page automatically transitions to the next step of the awaBerry device connection process.
3. Successfully Select Linux Mint and Proceed
This scenario guides you through selecting Linux Mint as your operating system and successfully proceeding to the next connection step.
- Step 1: Open the "Connect using Docker - select operating system" page.
- Step 2: Click or tap on the "Linux Mint" tile.
- Step 3: Observe a loading indicator briefly.
- Step 4: The page automatically transitions to the next step of the awaBerry device connection process.
Possible errors which may occur on this page
These scenarios describe potential issues you might encounter while using this page.
1. Device Limit Reached
This error occurs when you attempt to connect a new device but have already reached the maximum number of devices allowed by your current awaBerry license.
- Why it happens: Your awaBerry account has a limit on how many devices you can connect simultaneously. When you try to add another device beyond this limit, the system prevents it and redirects you to an upgrade page.
- Execution Steps:
- Step 1: Open the "Connect using Docker - select operating system" page.
- Step 2: Click or tap on any operating system tile (e.g., "Ubuntu").
- Step 3: Instead of proceeding to the next connection step, the page redirects you to the "Upgrade License" page, prompting you to increase your device capacity.
2. Error Creating Docker File (Backend Issue)
This error indicates an issue with the awaBerry backend system while trying to set up the initial configuration for your Docker installation.
- Why it happens: This could be due to temporary network problems, server maintenance, or an unexpected system error preventing the successful creation of necessary installation records.
- Execution Steps:
- Step 1: Open the "Connect using Docker - select operating system" page.
- Step 2: Click or tap on any operating system tile (e.g., "Debian").
- Step 3: Observe a loading indicator for a moment.
- Step 4: The loading indicator disappears, and a red error message box appears at the top of the page stating: "Error creating docker file - try again later." The page does not proceed to the next step.
