Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Feature] Create openbb-cli .dockerfile and update docs #6485

Merged
merged 5 commits into from
Jun 12, 2024
Merged

[Feature] Create openbb-cli .dockerfile and update docs #6485

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2f7dbcd
feat: create cli dockerfile and update docs
montezdesousa Jun 5, 2024
3dc09ad
remove port mapping
montezdesousa Jun 5, 2024
b19cad7
Remove cli image and docs
montezdesousa Jun 7, 2024
1ef22df
Merge branch 'develop' into feature/ghcr-images
montezdesousa Jun 7, 2024
5929020
Merge branch 'develop' into feature/ghcr-images
montezdesousa Jun 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions build/docker/api.dockerfile → build/docker/platform.dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@

COPY ./openbb_platform ./openbb_platform

# Install the SDK
# Install the Platform
RUN pip install /openbb/openbb_platform[all]
RUN pip install openbb-devtools

Expand All @@ -43,5 +43,5 @@

COPY --from=builder /usr/local /usr/local

# Specify the command to run
# Launch the API
CMD ["uvicorn", "openbb_core.api.rest_api:app", "--host", "0.0.0.0", "--port", "8000", "--reload"]
11 changes: 9 additions & 2 deletions website/content/platform/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,12 +168,19 @@ pip uninstall openbb[all]
### Docker

<details>
OpenBB provides a `.dockerfile` on [GitHub](https://github.com/OpenBB-finance/OpenBBTerminal).

You can install and run the Platform from [GitHub Container Registry](https://github.com/OpenBB-finance/OpenBBTerminal/pkgs/container/openbb-platform) with:

```bash
docker run --rm -p 8000:8000 -v ~/.openbb_platform:/root/.openbb_platform ghcr.io/openbb-finance/openbb-platform:latest
```

Alternatively, we provide a `.dockerfile` on [GitHub](https://github.com/OpenBB-finance/OpenBBTerminal).

Run the following command from the repo root to build the image:

```bash
docker build -f build/docker/api.dockerfile -t openbb-platform:latest .
docker build -f build/docker/platform.dockerfile -t openbb-platform:latest .
```

To run it:
Expand Down
Loading