Docker
Installing the OpenBB Terminal via Docker supports both Windows and Unix systems (Linux + MacOS). Installation differs a bit between operating system (Windows, macOS and Linux). Please select the section matching to your OS.
- Windows
- MacOS
- Linux
Install Docker Desktop
You can find Docker Desktop
for Windows here: Download Docker Desktop
Start Docker
Execute the following command:
docker info
If you have something like this, it means you haven't started Docker:
docker info
Server:
ERROR: Cannot connect to the Docker daemon at unix:///var/run/docker.sock.
Is the docker daemon running?
Start Docker, this is how the right output looks like:
docker info
Client:
Context: default
Debug Mode: false
Server:
Containers: 14
Running: 2
Paused: 1
Stopped: 10
Install VcXsrv
To display charts with your container, you need: VcXsrv.
You can download VcXsrv here: Download VcXsrv
Once downloaded you will open the program and accept all the defaults expect the below settings:
- CHECK the option:
Disable access control
and UNCHECK theNative opengl
command
Pull and run the container
Execute these commands:
curl -o docker-compose.yaml https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/main/build/docker/docker-compose.yaml
docker compose run openbb
This will download and run the file: docker-compose.yaml
This file contents the settings to pull and run OpenBB Terminal Docker image.
Install Docker Desktop
You can find Docker Desktop
for MacOS here: Download Docker Desktop
Start Docker
Execute the following command:
docker info
If you have something like this, it means you haven't started Docker:
docker info
Server:
ERROR: Cannot connect to the Docker daemon at unix:///var/run/docker.sock.
Is the docker daemon running?
Start Docker, this is how the right output looks like:
docker info
Client:
Context: default
Debug Mode: false
Server:
Containers: 14
Running: 2
Paused: 1
Stopped: 10
Install XQuartz
You can download XQuartz here: Download XQuartz
Open X Quartz.
Then on Preferences > Security
.
Make sure both of these options are enabled:
Authenticate connections
Allow connections from network clients
It should look like this:
Get Docker IP
To get Docker IP you can use this command:
IP=$(ifconfig | grep inet | grep -v "127.0.0.1" | awk '$1=="inet" {print $2}')
Pull and run the container
Execute these commands:
curl -o docker-compose.yaml https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/main/build/docker/docker-compose.yaml
xhost +$IP
docker compose run -e DISPLAY=$IP:0 openbb
This will download and run the file: docker-compose.yaml
This file contents the settings to pull and run OpenBB Terminal Docker image.
The xhost +$IP
and DISPLAY=$IP:0
parts are there to allow charts display.
Install Docker Desktop
You can find Docker Desktop
for Linux here: Download Docker Desktop
Start Docker
Execute the following command:
docker info
If you have something like this, it means you haven't started Docker:
docker info
Server:
ERROR: Cannot connect to the Docker daemon at unix:///var/run/docker.sock.
Is the docker daemon running?
Start Docker, this is how the right output looks like:
docker info
Client:
Context: desktop-linux
Debug Mode: false
Server:
Containers: 14
Running: 2
Paused: 1
Stopped: 10
Pull and run the container
Execute these commands:
curl -o docker-compose.yaml https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/main/build/docker/docker-compose.yaml
curl -o docker-compose.x11.yaml https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/main/build/docker/docker-compose.x11.yaml
docker compose -f docker-compose.yaml -f docker-compose.x11.yaml run openbb
If you are experiencing issues with charts - launch the container with the following command:
docker compose -f docker-compose.yaml -f docker-compose.x11.yaml run -e WEBKIT_DISABLE_COMPOSITING_MODE=1 openbb
If you're using remote docker host, you can connect with ssh -X <FQDN/IP>
.