User Manual
Connect using Docker - Mint
This page guides you through connecting a new device to awaBerry using Docker. It provides the necessary Docker files and step-by-step instructions to set up your awaBerry Docker image, allowing your device to join your awaBerry network.
Connect using Docker - Mint
Summary
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.
Page Access
You can access this page by navigating to: /connect_steps_docker?os=mint
Page Functionalities
This page offers the following functionalities to help you connect your device via Docker:
- Download Docker File: Click this button to download the specific Docker configuration file needed for your operating system (Mint) and selected Docker version.
- Download License: Use this button to download the required license file for your Docker installation.
- Docker Commands with Copy Option: The page displays three essential Docker commands:
- Docker Build Command: Used to create your awaBerry Docker image.
- Docker Run Command: Used to start your awaBerry Docker container.
- Docker Exec Command: Used to access the running awaBerry Docker container.
- Back to device list: This button allows you to return to your main list of connected devices within the awaBerry application.
Scenario Executions
Possible usage steps within this page
Here are typical steps you might follow to successfully connect your device using Docker:
- Download Docker File: Click the "Download Docker File (Mint latest)" button. Your browser will download the necessary Dockerfile. Save this file to a convenient location on your device where your Docker environment is running.
- Download License: Click the "Download license (Mint latest)" button. Your browser will download the required license file. Keep this file accessible as it might be needed during your Docker setup.
- Prepare Docker Environment: On your device (which should have Docker Desktop or Docker on Linux installed), store the downloaded Dockerfile.
- Execute Docker Build Command:
- Click the copy icon next to the "docker build..." command. This will copy the command to your clipboard.
- Open your terminal or command prompt.
- Navigate to the directory where you saved the Dockerfile.
- Paste the copied command and press Enter to build your awaBerry Docker image.
- Execute Docker Run Command:
- Click the copy icon next to the "containerid=$(docker run...)" command.
- Paste the copied command into your terminal and press Enter to start the awaBerry Docker container in the background.
- Execute Docker Exec Command:
- Click the copy icon next to the "docker exec -it..." command.
- Paste the copied command into your terminal and press Enter to access the running awaBerry Docker container. The awaBerry installation routine will start automatically.
- Monitor Installation: The installation routine for awaBerry will begin. Once complete, new Docker containers will appear in your awaBerry device list, and you will receive an email for each newly added container.
- Return to Device List: After successfully setting up your Docker container, click the "Back to device list" button to view your updated device list in the awaBerry application.
Possible errors which may occur on this page
While this page primarily provides instructions and downloads, it's part of a larger connection process where errors might arise. Here's a common error scenario:
Device Name Already In Use
If, during the overall device connection process (which includes steps before or after this page), you attempt to register a new device using a name that is already assigned to another device within your awaBerry account, you will encounter an error message stating: "Device name is already in use - please use another one."
This error occurs because each device connected to awaBerry requires a unique name for identification. To resolve this, simply choose a different, unique name for your new device and proceed with the connection steps.
