Skip to main content

Install Exorde Client from a container image

You can run Exorde Client using a container image from Docker Hub. If you are an advanced user, you also have the ability to build your own image from sources.

info

This documentation uses Docker as example, but commands should be the same for other container runtimes like Podman.

Requirements per Client​

  • Windows 8.1/10/11 or Linux or macOS
  • A container runtime, like Docker
  • 8 GB RAM per client instance
  • 4 CPU cores per client instance
  • 20 GB storage (HDD or SSD)

Minimal:​

  • Windows 8.1/10/11 or Linux or macOS
  • A container runtime, like Docker
  • 6 GB RAM per client instance
  • 2 CPU cores per client instance
  • 20 GB storage (HDD or SSD)

The image takes 10-12GB of disk space. Each container adds 3-4GB of disk used.

Running multiple clients on same machine​

It is possible to run multiple containers of the exorde-client image. Make sure to respect the minimal/recommended requirements per image.

It is recommended to use docker run --cpus=4 --memory=8g ... when running multiple containers to guarantee boundaries between containers. Overrunning (running too many client) won't result in increased data stream, performance or REP gain. A sweet spot has to be found.

  • For a normal 2-4-core (4-8 threads) CPU & 8 GB RAM, we recommend running at most 1-2 workers. Only one worker should be enough.
  • For a modern 4-core (8 threads) CPU & 16 GB RAM, we recommend running at most 2-3 workers.
  • For a high end 12-core (24 threads) CPU & 32 GB RAM, we recommend running at most 3-5 workers.

The client adapts to the capacity & power (CPU/RAM) allocated to it, so parallelizing isn't equivalent to a linear gain in REP/Performance.

Note on Docker Desktop for Windows​

By default, most docker desktop installations limit total (all containers combined) RAM usage to 4-8GB. If you intend on running multiple client (or just 1 powerful client), make sure to resize the limitations of your Docker Desktop. It involves simple steps:

  1. Find or create the config file located here: C:\Users\<UserName>.wslconfig.

  2. Stop Docker Desktop entierely.

  3. Make sure it's stopped on Windows by open a command line (cmd) and type: wsl --shutdown.

  4. Modify the .wslconfig file, for example like this:

    # Settings apply across all Linux distros running on WSL 2
    [wsl2]

    # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
    memory=16GB

    # Sets the VM to use two virtual processors
    processors=8

  5. Save .wslconfig after your modifications.

  6. Restart Docker Desktop.

  7. Launch/resume your containers.

You can follow this tutorial to change your Docker Memory & CPU Usage.

Method 1 - Install the official Exorde Client image​

The official Exorde Client image is a Linux image which runs natively on Linux and macOS with amd64 and arm64 CPU. Windows users must configure Docker in Linux container mode.

The latest image of Exorde Client can be retrieved from Docker Hub, this image is ready to run. You can directly go to the run section.

Method 2 - Build and run your own image​

You can build your own image from sources:

  1. Download the latest version of Exorde Client from GitHub release and save it as exorde-client.zip.
  2. Unzip Exorde Client:
    unzip exorde-client.zip \
    && rm exorde-client.zip \
    && mv exorde-client-main exorde-client
  3. Go to the root of Exorde Client folder:
    cd exorde-client
  4. Build the container image:
    docker build -t exorde-client:latest .
info

Exorde Client is now ready to run within a container!

Please read the run section to have more information about how to run Exorde Client.

Last updated on