Connect using Docker - select operating system -> Connect using Docker - Ubuntu

Connect using Docker - Ubuntu

Summary

This page is your guide to getting your awaBerry device connected using Docker on an Ubuntu system. It provides easy access to download essential Docker files and licenses, along with clear, step-by-step commands to set up the awaBerry Docker image. Follow these instructions to ensure a smooth and successful connection of your device.

Page Access

You can access this page by navigating to: /connect_steps_docker?os=ubuntu

Page Functionalities

This page provides the following functionalities to help you connect your awaBerry device using Docker on Ubuntu:

  • Download Docker File (for Ubuntu): Click this button to download the Docker file specifically configured for Ubuntu and your selected Docker version. This file is crucial for setting up the awaBerry Docker image on your system.
  • Download License (for Ubuntu): Click this link to download the necessary license file for the awaBerry Docker image, tailored for Ubuntu and your selected Docker version.
  • Copy Docker Build Command: This text box displays the command you need to execute in your terminal to build the awaBerry Docker image. Click the copy icon next to it to easily copy the command to your clipboard.
  • Copy Docker Run Command: This text box shows the command for running the awaBerry Docker container. Click the copy icon to quickly copy it to your clipboard for execution.
  • Copy Docker Exec Command: This text box provides the command to access the running awaBerry Docker container's command line interface. Click the copy icon to copy it.
  • Back to device list Button: Click this button to return to the list of your devices, allowing you to navigate back if needed.

Scenario Executions

Possible usage steps within this page

The primary goal on this page is to successfully download the required Docker files and commands, and understand the steps to set up your awaBerry Docker image.

  1. Step 1: Download Docker File. Locate and click the "Download Docker File (Ubuntu latest)" button. Your web browser will download the Dockerfile needed for setup.
  2. Step 2: Download License. Locate and click the "Download license (Ubuntu latest)" link. This will download the corresponding license file.
  3. Step 3: Understand Storage Instruction. Read the instruction that says: "On a device running a docker environment (Docker Desktop, Docker on Linux, ..) store the downloaded dockerfile." This tells you where to save the downloaded file.
  4. Step 4: Understand Execution Instruction. Read the instruction: "Execute the following steps to start the awaBerry docker image:" which introduces the commands you'll need.
  5. Step 5: Copy and Execute Docker Build Command. Find the text box containing the "docker build" command. Click the copy icon next to it to transfer the command to your clipboard. Open your Docker environment's terminal, paste the command, and press Enter to build the awaBerry Docker image.
  6. Step 6: Copy and Execute Docker Run Command. Locate the text box with the "containerid=" command. Click its copy icon, then paste and execute it in your terminal to run the awaBerry Docker container.
  7. Step 7: Copy and Execute Docker Exec Command. Find the text box with the "docker exec" command. Click its copy icon, then paste and execute it in your terminal to access the running container's command line.
  8. Step 8: Automatic Device Addition. Note the information that "New devices are added automatically once the docker environment runs." No action is needed from you for this step.
  9. Step 9: Return to Device List. Click the "Back to device list" button to navigate away from this setup page and return to your overview of connected devices.

Possible errors which may occur on this page

While using this page, you might encounter some issues:

  • Download Failure: If the Docker File or License file does not download when clicked, it could be due to an internet connection issue, a temporary problem with the awaBerry server, or restrictive browser security settings. Try checking your internet connection, attempting the download again, or using a different web browser.
  • Copy Command Issue: If clicking a copy icon does not transfer the command text to your clipboard, this might be due to browser restrictions on clipboard access or a temporary system glitch. Try clicking the icon again. If it persists, you may need to manually select and copy the text.
  • Invalid Download Link: If clicking a download link results in a "page not found" or "invalid URL" error in your browser, it indicates that the generated download link is incorrect or the file no longer exists on the server. This is a system-level issue; please report it to awaBerry support with details of your selected operating system and Docker version.
  • "Device name is already in use" Error: Although there isn't an input field for a device name directly on this page, an error message such as "Device name is already in use - please use another one" might appear if a device name chosen in a previous step conflicts with an existing one. If you see this, you will need to go back to the step where the device name was specified and choose a unique name.

Up to User Manual Main Page