Skip to main content
Version: Torizon OS 7.x.y

Install TorizonCore Builder

Introduction​

This article guides you on how to install TorizonCore Builder. The installation process consists of the following steps:

  • Set up your host Linux or Windows host Machine: Ensure that your development PC has all the required dependencies to run TorizonCore Builder.
  • Install TorizonCore Builder: Learn how to install it via the command line and source its environment script.

This article complies with the Typographic Conventions for Torizon Documentation.

Prerequisites​

Linux Host Machine Requirements​

  • Docker Engine: Install Docker Engine.

  • Bash Shell: TorizonCore Builder may work with other shells, but we do not guarantee it.

    If you run into an issue in a non-Bash shell, report it on our community website.

Windows Host Machine Requirements​

  • Windows 11 / Windows 10 version 2004 or later: TorizonCore Builder requires a Linux environment. These are the Windows versions that support WSL 2.
  • WSL 2: Install WSL 2.
  • Docker Engine: Install Docker Engine.

As a reminder, all TorizonCore Builder commands should be run in your WSL 2 distro.

tip

You will occasionally need to transfer files to and from your WSL 2 distro and your Windows host. To do this, you can use the built-in File Explorer. You can also invoke Windows utilities from within your WSL 2 distro. For example, run:

$ explorer.exe .

This command opens File Explorer in the current directory. From there, you can copy and move files between WSL 2 and Windows.

Install TorizonCore Builder​

Follow the steps below to install TorizonCore Builder:

  1. Download the setup script into some writable directory in your system (here we use ~/tcbdir/):

    $ mkdir -p ~/tcbdir/ && cd ~/tcbdir/
    $ wget https://raw.githubusercontent.com/toradex/tcb-env-setup/master/tcb-env-setup.sh

  2. Source the script:

    $ cd ~/tcbdir/
    $ source tcb-env-setup.sh

    This script:

    • Mounts your current directory into the container. Files outside this directory won't be accessible from inside the container.
    • Creates a Docker volume named storage, which stores project state, unpacked images, image artifacts, and other internal metadata used by TorizonCore Builder.
    • Sources a Bash completion script script for command-line auto-completion using the TAB key.
    Proxy server configuration (TorizonCore Builder 3.13.0+)

    With TorizonCore Builder 3.13.0+, when using a non-transparent proxy server:

    • Configure your Docker client according to the Docker proxy configuration page.

    • Source the script, passing extra information about your proxy (adjust the variables as needed):

      $ cd ~/tcbdir/
      $ source tcb-env-setup.sh -- \
            --env HTTP_PROXY="http://proxy.example.com:3128" \
            --env HTTPS_PROXY="https://proxy.example.com:3129" \
            --env NO_PROXY="*.test.example.com,.example.org,127.0.0.0/8" \
            --env DIND_FORWARD_VARS=HTTP_PROXY,HTTPS_PROXY,NO_PROXY

  3. Test whether the torizoncore-builder command is available:

    $ torizoncore-builder --help

Early-Access and Advanced Use Cases​

To see advanced use case options, run source tcb-env-setup.sh -h or read the project README.

The README also includes information about using the early-access version of the tool:

tip

Remember to source the setup script every time you start a new terminal (or shell instance).

Send Feedback!