Run Exorde Client within a container
The container image has been tested with Docker only, but it should run with other container runtime like Podman.
Run the official Exorde Client container 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. The image is between 10 and 15 GB. It should be almost ready and will download once a few models & other elements at first start. The client will then be autonomous. Only a main address (valid & formatted) should be provided.
Run Exorde Client in background mode (for VPS)
The background mode is best suited for servers and long-running instances on computers. Logs are not printed on the console but they are visible using docker logs -f <CONTAINER_NAME>.
Use the following command to run Exorde Client in background mode:
docker run \
-d \
--restart unless-stopped \
--pull always \
--name <CONTAINER_NAME> \
exordelabs/exorde-client \
--main_address <YOUR_MAIN_ADDRESS>
The container will restart automatically in case of failure or remote update.
Example
Run:
docker run \
-d \
--restart unless-stopped \
--pull always \
--name exorde-client\
exordelabs/exorde-client\
--main_address 0x0F67059ea5c125104E46B46769184dB6DC405C42
Show logs:
docker logs -f exorde-client
You can run several instances of Exorde Client, with the same main address. Just make sure to change container's name with the option --name and use --cpus and --memory parameters to limit each container's ressources.
Run Exorde Client in foreground mode (for local computer)
The foreground mode is best suited for computers if you want to run the Exorde Client temporally or to test it. Logs are printed on the console and the process runs while the console is open.
Use the following command to run Exorde Client in foreground mode:
docker run \
--restart unless-stopped \
--pull always \
--name <CONTAINER_NAME> \
exordelabs/exorde-client \
--main_address <YOUR_MAIN_ADDRESS>
The container will restart automatically in case of failure or remote update.
Example
Run:
docker run \
--restart unless-stopped \
--pull always \
--name exorde-client\
exordelabs/exorde-client \
--main_address 0x0F67059ea5c125104E46B46769184dB6DC405C42
Run an own build Exorde Client image
Own build container images of Exorde Client can be run in the same way as the official image. You only have to tell to your container runtime to use your image instead of the official one.
For example, if you have built the image with the command docker build -t exorde-client:latest ., you can run Exorde Client with the following command:
docker run --name <CONTAINER_NAME> exorde-client --main_address <YOUR_MAIN_ADDRESS>
When running many clients on 1 machine, or if you want to limit precisely the capacity of the container:
docker run --restart unless-stopped --cpus=4 --memory=6g --name <CONTAINER_NAME> exorde-client --main_address <YOUR_MAIN_ADDRESS>
You can adapt --cpus and --memory. We recommend not to go below --cpus=1, and not below --memory=4g
Please refer to the previous section for detailed instructions.