From 107379af7c4e188415ba7e8e97ba662be31561e1 Mon Sep 17 00:00:00 2001 From: Jacques Verre Date: Mon, 16 Sep 2024 13:44:27 +0100 Subject: [PATCH] Update docs --- .../documentation/docs/self-host/local_deployment.md | 8 ++++++-- .../documentation/docs/self-host/overview.md | 2 +- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/apps/opik-documentation/documentation/docs/self-host/local_deployment.md b/apps/opik-documentation/documentation/docs/self-host/local_deployment.md index 71ff131fd9..763fcd89d2 100644 --- a/apps/opik-documentation/documentation/docs/self-host/local_deployment.md +++ b/apps/opik-documentation/documentation/docs/self-host/local_deployment.md @@ -24,8 +24,8 @@ To install Opik, you will need to clone the Opik repository and run the `docker- # Clone the Opik repository git clone https://github.com/comet-ml/opik.git -# Navigate to the opik directory -cd opik +# Navigate to the opik/deployment/docker-compose directory +cd opik/deployment/docker-compose # Start the Opik platform docker compose up --detach @@ -50,6 +50,10 @@ All the data logged to the Opik platform will be stored in the `~/opik` director ## Starting, stopping and upgrading Opik +:::note +All the `docker compose` commands should be run from the `opik/deployment/docker-compose` directory. +::: + The `docker compose up` command can be used to install, start and upgrade Opik: ```bash diff --git a/apps/opik-documentation/documentation/docs/self-host/overview.md b/apps/opik-documentation/documentation/docs/self-host/overview.md index 21e081e47e..21d2fbe753 100644 --- a/apps/opik-documentation/documentation/docs/self-host/overview.md +++ b/apps/opik-documentation/documentation/docs/self-host/overview.md @@ -21,7 +21,7 @@ If you would like to try out Opik locally, we recommend using our Local installa git clone https://github.com/comet-ml/opik.git # Run the Opik platform -cd opik +cd opik/deployment/docker-compose docker compose up --detach # Configure the Python SDK to point to the local Opik platform