Skip to content

Commit

Permalink
Updating advanced docker documentation to reference the new container (
Browse files Browse the repository at this point in the history
…#1655)

* Updating advanced docker documentation to reference the new container

* Fixing list
  • Loading branch information
aia authored Apr 7, 2022
1 parent cbed180 commit 99e070d
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 17 deletions.
2 changes: 1 addition & 1 deletion DOCKER_ADVANCED.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ then run the container (`path/to/setenv`) should be replaced with wherever this
downloaded the entire repository and your current directory is `OpenBBTerminal`, then the path would be `docker/setenv`

```bash
docker run -it --rm --env-file=path/to/setenv ghcr.io/OpenBBTerminal/gst-poetry:latest
docker run -it --rm --env-file=path/to/setenv ghcr.io/openbb-finance/openbbterminal-poetry:latest
```

## Display
Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@

<h3 align="center">OpenBB Terminal 🚀</h3>
<p align="center">Click on the GIF below for a DEMO of the terminal.</p>

<p align="center">
<a href="https://www.youtube.com/watch?v=fqGPK8OVHLk" rel="honest work">
<img src="images/usage.gif" alt="drawing" width="1000"/>
Expand Down Expand Up @@ -98,7 +98,8 @@ If you wish to install the Terminal, there are currently four options:
- [Using the Installer](openbb_terminal/README.md#User) (recommended if you just want to use the terminal)
- [Using Python](openbb_terminal/README.md#anaconda--python) (recommended if you want to develop new features)
- [Using Docker](openbb_terminal/README.md#Docker-Installation) (alternative option to the installer if preferred)
- [Using Docker Web UI](openbb_terminal/README.md#web-ui---docker) (if you want to deploy the web UI for users to access over your LAN)
- [Using Docker Web UI](openbb_terminal/README.md#web-ui---docker) (if you want to deploy the web UI for users to access
over your LAN)

## Contributing

Expand Down
46 changes: 32 additions & 14 deletions openbb_terminal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ First step in all options is to star the project

<img width="1272" alt="Github starts" src="https://user-images.githubusercontent.com/25267873/115989986-e20cfe80-a5b8-11eb-8182-d6d87d092252.png">

If you want to install the terminal using Python ignore the User section and jump to <a href="#Anaconda & Python">Anaconda & Python</a> section.
If you want to install the terminal using Python ignore the User section and jump to <a href="#Anaconda & Python">
Anaconda & Python</a> section.

## User

Expand Down Expand Up @@ -76,15 +77,21 @@ files from the .dmg file.

### Anaconda & Python

This installation type supports both Windows and Unix systems (Linux + MacOS). However, on Windows it can become messy so it is easier to use Windows Subsystem Linux (WSL) on this operating system. WSL emulates a Linux machine inside your Windows system.
This installation type supports both Windows and Unix systems (Linux + MacOS). However, on Windows it can become messy
so it is easier to use Windows Subsystem Linux (WSL) on this operating system. WSL emulates a Linux machine inside your
Windows system.

If you are using macOS or other Linux operating systems you can jump the next section <a href="#installing-the-terminal">Installing the terminal</a>.
If you are using macOS or other Linux operating systems you can jump the next section
<a href="#installing-the-terminal">Installing the terminal</a>.

#### Installing WSL (Only for Windows users)

If you are using Windows you first you need to install WSL. The process is simple and a tutorial can be found [here](https://www.sitepoint.com/wsl2/). Once you reach the section **Update Linux** on that tutorial, you should have a linux machine installed and can proceed to the next steps.
If you are using Windows you first you need to install WSL. The process is simple and a tutorial can be found [here](https://www.sitepoint.com/wsl2/).
Once you reach the section **Update Linux** on that tutorial, you should have a linux machine installed and can proceed
to the next steps.

Since WSL installation is headless by default (i.e., you have only access to a terminal running a linux distribution) you need some extra steps to be able to visualize the charts produced by the terminal (more detailed tutorial [here](https://medium.com/@shaoyenyu/make-matplotlib-works-correctly-with-x-server-in-wsl2-9d9928b4e36a)):
Since WSL installation is headless by default (i.e., you have only access to a terminal running a linux distribution)
you need some extra steps to be able to visualize the charts produced by the terminal (more detailed tutorial [here](https://medium.com/@shaoyenyu/make-matplotlib-works-correctly-with-x-server-in-wsl2-9d9928b4e36a)):

1. Dynamically export the DISPLAY environment variable in WSL2:

Expand All @@ -100,7 +107,9 @@ Since WSL installation is headless by default (i.e., you have only access to a t

After this, `VcXsrv` should be running successfully and we can proceed to terminal installation.

Although we **extremely** recommend using WSL to run the terminal on windows, if you don't want or can't for some reason, you can try install the terminal directly on Windows without WSL. If you'd like to see a video recording of the installation on Windows without WSL, @JohnnyDankseed has made one available [here](https://www.youtube.com/watch?v=-DJJ-cfquDA).
Although we **extremely** recommend using WSL to run the terminal on windows, if you don't want or can't for some reason,
you can try install the terminal directly on Windows without WSL. If you'd like to see a video recording of the
installation on Windows without WSL, @JohnnyDankseed has made one available [here](https://www.youtube.com/watch?v=-DJJ-cfquDA).

#### Installing the terminal

Expand All @@ -120,9 +129,11 @@ Anaconda's Python distribution.

- If you are using macOS click [Installing on MacOS](https://docs.anaconda.com/anaconda/install/mac-os/)
- If you are using WSL or Linux click [Installing on Linux](https://docs.anaconda.com/anaconda/install/linux/)
- If you are using Windows click [Installing on Windows](https://docs.anaconda.com/anaconda/install/windows/). **ONLY REQUIRED IF NOT USING WSL**, you also need to install/update Microsoft C++ Build Tools from here: <https://visualstudio.microsoft.com/visual-cpp-build-tools/>
- If you are using Windows click [Installing on Windows](https://docs.anaconda.com/anaconda/install/windows/).
**ONLY REQUIRED IF NOT USING WSL**, you also need to install/update Microsoft C++ Build Tools from here: <https://visualstudio.microsoft.com/visual-cpp-build-tools/>

- After following the steps, confirm that you have it by opening a terminal and running: `conda -V`. The output should be something along the lines of: `conda 4.9.2`
- After following the steps, confirm that you have it by opening a terminal and running: `conda -V`. The output
should be something along the lines of: `conda 4.9.2`

2. Install git

Expand Down Expand Up @@ -193,7 +204,8 @@ Anaconda's Python distribution.
before you call `python terminal.py` again.

**TROUBLESHOOT:** If you are having troubles to install, check our _newest_
<a href="https://github.com/OpenBB-finance/OpenBBTerminal/blob/master/TROUBLESHOOT.md"><strong>troubleshoot page</strong></a>. You can also reach for help on our [discord](https://discord.gg/Up2QGbMKHY).
<a href="https://github.com/OpenBB-finance/OpenBBTerminal/blob/master/TROUBLESHOOT.md">
<strong>troubleshoot page</strong></a>. You can also reach for help on our [discord](https://discord.gg/Up2QGbMKHY).

### Advanced User Install - Machine Learning

Expand Down Expand Up @@ -268,7 +280,9 @@ git stash pop
docker pull ghcr.io/openbb-finance/openbbterminal-poetry:latest
```

Upon running this the first time, you should see the various layers downloading (note the random series of letters numbers will vary). The first time this is run, it will take a few minutes. Subsequent updates will be much faster, as the changes will be in the MB instead of GB.
Upon running this the first time, you should see the various layers downloading (note the random series of letters
numbers will vary). The first time this is run, it will take a few minutes. Subsequent updates will be much faster,
as the changes will be in the MB instead of GB.

![Screen Shot 2021-09-08 at 10 41 08 AM](https://user-images.githubusercontent.com/18151143/132531075-7d7f7e71-4fcb-435c-9bb3-466d7077eba4.png)

Expand All @@ -289,7 +303,8 @@ git stash pop
This will open up the terminal in your command prompt or terminal. Note that this has provided now environment file,
so you will not be able to view plots or use keys at this stage.

At this point, you should be able to use the majority of the features using Docker. To read more on adding the environment keys and how to configure your X-server to show plots, hop over to the
At this point, you should be able to use the majority of the features using Docker. To read more on adding the
environment keys and how to configure your X-server to show plots, hop over to the
[Advanced Docker Setup](/DOCKER_ADVANCED.md).

### Web UI - Docker
Expand All @@ -298,7 +313,8 @@ git stash pop
2. Navigate to the location of the Dockerfile in the repo (`cd openbb_terminal_web`)
3. Ensure the launcher is executable with `chmod +x ./launch`
4. Launch it with `./launch`. If you get a permission denied error, do `sudo ./launch` instead
5. Once it's launched, you will be able to access it by going to `http://host-ip:8080` in a browser, or `http://localhost:8080` if you are running it on your local machine.
5. Once it's launched, you will be able to access it by going to `http://host-ip:8080` in a browser, or
`http://localhost:8080` if you are running it on your local machine.

For API keys, create the `setenv` file if it doesn't already exist.
It will automatically get created on the first launch, and won't get committed to Git because it is on the `.gitignore`.
Expand All @@ -316,15 +332,17 @@ There are a few things that still don't work, and you can see what works and wha

Once completed reboot and lets reopen.

2. [Install Miniforge](https://github.com/conda-forge/miniforge) The community version of anaconda/miniconda that has Arm support.
2. [Install Miniforge](https://github.com/conda-forge/miniforge) The community version of anaconda/miniconda that has
Arm support.

- Follow the on screen prompts to install miniforge(conda).

```bash
wget https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Linux-aarch64.sh
```

- After following the steps, confirm that you have it by opening a terminal and running: `conda -V`. The output should be something along the lines of: `conda 4.9.2`
- After following the steps, confirm that you have it by opening a terminal and running: `conda -V`. The output
should be something along the lines of: `conda 4.9.2`

3. Install git

Expand Down

0 comments on commit 99e070d

Please sign in to comment.