Installing the Depot Client

The Depot Client (depot) is a command-line tool that automates repository configuration on your systems.

Prerequisites

A CIQ Portal account with an active organization
Your access credentials from https://portal.ciq.com/token
Root or sudo access on the target system
An EL8, EL9, or EL10 system (Rocky Linux, RHEL, or another RPM-based EL-compatible distribution), on x86_64 or aarch64

Installation

From the CIQ Repository (Recommended)

Add the CIQ public repository and install:


sudo dnf config-manager --add-repo https://depot.ciq.com/dlv2/depot-el\$releasever.\$basearch/
sudo rpm --import https://ciq.com/keys/rpm-gpg-key-ciq
sudo dnf install depot

Alternatively, install directly from the RPM URL without adding a repository:


sudo rpm --import https://ciq.com/keys/rpm-gpg-key-ciq
sudo dnf install -y https://depot.ciq.com/dlv2/depot-el$(rpm -E %{rhel}).$(uname -m)/depot.rpm

EL10 systems

The direct RPM URL is not published for EL10. On EL10 systems, use the repository method above.

Updates

This method installs depot without configuring the CIQ repository, so dnf update will not automatically upgrade depot. To update, rerun the command above or use the repository-based method.

From Portal

A direct link to the Depot Client installation is also available on the Access Token page in the Portal.

Authenticating

After installation, log in with your access token from the Portal:


sudo depot login -u YOUR_USERNAME -t YOUR_TOKEN

Replace YOUR_USERNAME and YOUR_TOKEN with the credentials from your Access Token page.

You should see:


Connected to https://depot.ciq.com

Root Required

The Depot Client must be run with root privileges (sudo) because it writes repository configuration files and stores credentials in root-owned, permission-restricted files.

Flag	Description
`-u, --user`	Username (required)
`-t, --token`	Access token (required)
`-s, --server`	Server URL (default: `https://depot.ciq.com`)
`-f, --force`	Force re-login over existing credentials

You can also set credentials via environment variables: DEPOT_USER, DEPOT_TOKEN, DEPOT_SERVER.

Verifying Installation

Check that the Depot Client is installed and authenticated:


sudo depot list

This displays the products available to your organization:


PRODUCT_ID    PRODUCT_NAME                              ENABLED
rlc-pro-9     RLC Pro 9                                 no
lts-9.4       Rocky Linux 9.4 Long Term Support         no
bridge        CIQ Bridge (CentOS 7 extended life)       no

Check your installed version:


depot --version

Depot Client Commands

Command	Description
`depot login`	Authenticate with CIQ Depot
`depot list`	List available products (alias: `ls`)
`depot enable`	Enable products and configure repositories
`depot disable`	Disable products and remove repo configuration
`depot refresh`	Refresh all configured products
`depot download`	Download a file from Depot
`depot upload`	Upload a file to a repository
`depot help`	Display help for any command

Global Flags

Flag	Description
`-d, --debug`	Enable debug mode with verbose output
`-j, --json`	Output in JSON format
`-v, --version`	Show version information

Automatic Refresh

The Depot Client installs a systemd timer (depot-refresh.timer) that automatically runs depot refresh to regenerate the repository configurations for your enabled products. The timer runs 30 seconds after boot and every 7 days thereafter, keeping your repository configurations current.

For full details on the refresh command and managing the systemd timer, see Maintenance.

Next Steps

Setting Up Host: Configure repositories on your system
Working with Containers: Access container images
Maintenance: Keeping your Depot Client and repositories up to date

Overview Setting Up Your Host