Quickstart

This quickstart show most common commands to run Exorde Client. Please check Install and Run sections for more details.

Instructions

You have several choices to run Exorde Client:

• Run from sources inside a virtual Python environment
• Run from a Docker image

Exorde Client does not come with a GUI, it aims to be used by advanced users who want to run it inside a terminal. The installation process assume that users who run Exorde Client are familiar with command lines.

Using the container image is the recommanded way to run Exorde Client, as it avoid dependencies issues, handles automatic restart in case of failure/application update and make multi easier to run multiple instances of the application.

Requirements

• 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.

Quickstart using Docker on a Linux VPS

1. Install Docker.

2. Run the program in background with autorestart:

   docker run \
   -d \
   --restart unless-stopped \
   --pull always \
   --name <CONTAINER_NAME> \
   exordelabs/exorde-client \
   --main_address <YOUR_MAIN_ADDRESS>

   Usage example:

   docker run \
   -d \
   --restart unless-stopped \
   --pull always \
   --name exorde-client \
   exordelabs/exorde-client \
   --main_address 0x0F67059ea5c125104E46B46769184dB6DC405C42

For more detailled informations, please read the full documentation.

How to update the Docker image:

If you are already running Exorde Client with Docker and you want to use a new uploaded image, please follow these instructions:

1. Stop and delete all running containers of Exorde Client:

   docker stop <CONTAINER_NAME> && docker rm <CONTAINER_NAME>

   For example, if you are running only one container named "exorde-client":

   docker stop exorde-client && docker rm exorde-client

2. Start new containers:

   docker run \
   -d \
   --restart unless-stopped \
   --pull always \
   --name <CONTAINER_NAME> \
   exordelabs/exorde-client \
   --main_address <YOUR_MAIN_ADDRESS>

Automatic updates

The module detects available updates and automatically installs them. This is important for the Exorde Network to remain hommogenous.