summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--build/docker/platform.dockerfile (renamed from build/docker/api.dockerfile)4
-rw-r--r--website/content/platform/installation.mdx11
2 files changed, 11 insertions, 4 deletions
diff --git a/build/docker/api.dockerfile b/build/docker/platform.dockerfile
index e8b7ac7e643..3bbfb2ae436 100644
--- a/build/docker/api.dockerfile
+++ b/build/docker/platform.dockerfile
@@ -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
@@ -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"]
diff --git a/website/content/platform/installation.mdx b/website/content/platform/installation.mdx
index 4c34e21fb4e..379ba93c54b 100644
--- a/website/content/platform/installation.mdx
+++ b/website/content/platform/installation.mdx
@@ -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: