From 52eba11d6a1dd582ebfcd23dba5fc8e8a032cf73 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=CA=88=E1=B5=83=E1=B5=A2?= Date: Tue, 26 Sep 2023 10:16:52 -0400 Subject: [PATCH] docs: update docker-compose to match latest release (#25332) Also notes that one needn't build a new image. Co-authored-by: Sam Firke Co-authored-by: JUST.in DO IT --- .../installing-superset-using-docker-compose.mdx | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/docs/installation/installing-superset-using-docker-compose.mdx b/docs/docs/installation/installing-superset-using-docker-compose.mdx index d0451fb19a4f4..46c50d2524a0a 100644 --- a/docs/docs/installation/installing-superset-using-docker-compose.mdx +++ b/docs/docs/installation/installing-superset-using-docker-compose.mdx @@ -62,6 +62,9 @@ When working on master branch, run the following commands to run `development` m ```bash docker compose up ``` +:::tip +When running in development mode the `superset-node` container needs to finish building assets in order for the UI to render properly. If you would just like to try out Superset without making any code changes follow the steps documented for `production` or a specific version below. +::: When working on master branch, run the following commands to run `production` mode using `docker compose`: @@ -72,12 +75,12 @@ docker-compose -f docker-compose-non-dev.yml up Alternatively, you can also run a specific version of Superset by first checking out the branch/tag, and then starting `docker-compose` with the `TAG` variable. -For example, to run the 2.1.0 version, run the following commands: +For example, to run the 3.0.0 version, run the following commands: ```bash -git checkout 2.1.0 -TAG=2.1.0 docker-compose -f docker-compose-non-dev.yml pull -TAG=2.1.0 docker-compose -f docker-compose-non-dev.yml up +git checkout 3.0.0 +TAG=3.0.0 docker-compose -f docker-compose-non-dev.yml pull +TAG=3.0.0 docker-compose -f docker-compose-non-dev.yml up ``` :::tip @@ -94,10 +97,6 @@ You should see a wall of logging output from the containers being launched on yo this output slows, you should have a running instance of Superset on your local machine! To avoid the wall of text on future runs, add the `-d` option to the end of the `docker-compose up` command. -**Note:** This will bring up superset in a non-dev mode, changes to the codebase will not be reflected. -If you would like to run superset in dev mode to test local changes, simply replace the previous command with: `docker-compose up`, -and wait for the `superset_node` container to finish building the assets. - #### Configuring Docker Compose The following is for users who want to configure how Superset runs in Docker Compose; otherwise, you can skip to the next section.