User Manual
Connect using Docker - Ubuntu
This page guides you through connecting your awaBerry device using Docker on an Ubuntu system, including downloading necessary files and executing setup commands.
Connect using Docker - Ubuntu
Summary
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?os=ubuntu
Page Functionalities
- "Download Docker File" Button: This button allows you to download the specific Docker configuration file tailored for your awaBerry device on Ubuntu (e.g., "Download Docker File (ubuntu latest)"). Clicking it will open a new browser tab or window to initiate the download.
- "Download license" Link: This link provides access to the necessary license file for your Docker setup (e.g., "Download license (ubuntu latest)"). Clicking it will open a new browser tab or window to download the license.
- Docker Build Command: This section displays the command you need to run in your terminal to build the awaBerry Docker image from the downloaded Docker file. It includes a copy button to easily transfer the command to your clipboard.
- Docker Run Command: This section displays the command to start a new awaBerry Docker container. It also includes a copy button for easy clipboard transfer.
- Docker Exec Command: This section displays the command to access the running awaBerry Docker container's command line. It includes a copy button for easy clipboard transfer.
- "Back to device list" Button: This button allows you to return to the main list of your devices, cancelling the current connection process.
Scenario Executions
Possible usage steps within this page
1. Downloading Docker Files
- Step 1: Locate and click the "Download Docker File (ubuntu latest)" button. Your browser will initiate the download of the Docker setup file.
- Step 2: Locate and click the "Download license (ubuntu latest)" link. Your browser will initiate the download of the license file.
- Outcome: You will have both the Docker file and the license file saved on your computer, ready for the next steps.
2. Setting Up the awaBerry Docker Image
- Step 1: On your device running a Docker environment (like Docker Desktop or Docker on Linux), store the downloaded Docker file.
- Step 2: Open a terminal or command prompt in the directory where you saved the Docker file.
- Step 3: Copy the "Docker Build Command" (e.g.,
docker build --progress=plain --build-arg CACHE_BUST=<CURRENT_TIMESTAMP> -t ubuntu_awaberry_default .) by clicking the copy icon next to it. Paste the command into your terminal and press Enter to build the awaBerry Docker image. - Step 4: After the build completes, copy the "Docker Run Command" (e.g.,
containerid=$(docker run -d -p 80:80 -p 443:443 -v /host/path/for/awaberry_data:/var/lib/awaberry ubuntu_awaberry_default)) and paste it into your terminal, then press Enter to start the awaBerry Docker container. - Step 5: If you need to access the command line inside your running Docker container, copy the "Docker Exec Command" (e.g.,
docker exec -it <container_id> /bin/bash) and paste it into your terminal, then press Enter. - Outcome: The awaBerry Docker image will be built and running on your system, and new devices will be automatically added.
3. Returning to the Device List
- Step 1: After completing your Docker setup or if you decide to cancel, click the "Back to device list" button.
- Outcome: You will be redirected to the main device list page.
Possible errors which may occur on this page
1. Download Failures
- Error: The Docker file or license download does not start, or the browser reports a download error.
- Why it happens: This typically occurs if there's a problem with your internet connection, a temporary issue with the download server, or if your browser's security settings prevent the download.
- What to do: Check your internet connection. Try clicking the download buttons again. If the problem persists, ensure your browser is up-to-date and temporarily relax any strict download security settings if safe to do so.
2. Docker Command Execution Errors
- Error: When you paste and run the Docker commands in your terminal, you receive error messages such as "command not found," "docker daemon not running," or build/run failures.
- Why it happens: This indicates that Docker might not be correctly installed or running on your system, or there's a syntax error if you modified the copied command. Build failures can also occur if the downloaded Docker file is corrupted or if there are underlying system resource issues.
- What to do:
- Ensure Docker Desktop (for Windows/macOS) or Docker Engine (for Linux) is installed and running on your machine.
- Verify that you copied the commands exactly as provided, without any modifications.
- Consult Docker's official documentation for troubleshooting specific Docker error messages.
