From 0778f4ab28756d09cea1f766d32abbd123331092 Mon Sep 17 00:00:00 2001 From: Jonathan Hult Date: Sat, 10 Jul 2021 12:30:35 -0500 Subject: [PATCH] docs(docker): update README (#15607) Fix broken README links Update Grammar Update blurb about Production mode --- docker/README.md | 44 +++++++++++++++++++------------------------- 1 file changed, 19 insertions(+), 25 deletions(-) diff --git a/docker/README.md b/docker/README.md index 5cda2aa472..c867121dae 100644 --- a/docker/README.md +++ b/docker/README.md @@ -24,58 +24,52 @@ Docker is an easy way to get started with Superset. ## Prerequisites 1. Docker! [link](https://www.docker.com/get-started) -1. Docker-compose [link](https://docs.docker.com/compose/install/) +2. Docker-compose [link](https://docs.docker.com/compose/install/) ## Configuration -The `/app/pythonpath` folder is mounted from [./docker/pythonpath_dev](./docker/pythonpath_dev) -which contains a base configuration [./docker/pythonpath_dev/superset_config.py](./docker/pythonpath_dev/superset_config.py) +The `/app/pythonpath` folder is mounted from [`./docker/pythonpath_dev`](./pythonpath_dev) +which contains a base configuration [`./docker/pythonpath_dev/superset_config.py`](./pythonpath_dev/superset_config.py) intended for use with local development. ### Local overrides -In order to override configuration settings locally, simply make a copy of [./docker/pythonpath_dev/superset_config_local.example](./docker/pythonpath_dev/superset_config_local.example) -into [./docker/pythonpath_dev/superset_config_docker.py](./docker/pythonpath_dev/superset_config_docker.py) (git ignored) and fill in your overrides. +In order to override configuration settings locally, simply make a copy of [`./docker/pythonpath_dev/superset_config_local.example`](./pythonpath_dev/superset_config_local.example) +into `./docker/pythonpath_dev/superset_config_docker.py` (git ignored) and fill in your overrides. ### Local packages -If you want to add python packages in order to test things like DBs locally, you can simply add a local requirements.txt (./docker/requirements-local.txt) -and rebuild your docker stack. +If you want to add Python packages in order to test things like databases locally, you can simply add a local requirements.txt (`./docker/requirements-local.txt`) +and rebuild your Docker stack. Steps: - 1. Create ./docker/requirements-local.txt - 2. Add your new packages - 3. Rebuild docker-compose - a. `docker-compose down -v` - b. `docker-compose up` + +1. Create `./docker/requirements-local.txt` +2. Add your new packages +3. Rebuild docker-compose + 1. `docker-compose down -v` + 2. `docker-compose up` ## Initializing Database -The DB will initialize itself upon startup via the init container (superset-init) -(This may take a minute.) +The database will initialize itself upon startup via the init container ([`superset-init`](./docker-init.sh)). This may take a minute. ## Normal Operation -To run the container, simply run: +To run the container, simply run: `docker-compose up` -```bash -docker-compose up -``` - -After several minutes for superset initialization to finish, you can open a browser and view [`http://localhost:8088`](http://localhost:8088) +After waiting several minutes for Superset initialization to finish, you can open a browser and view [`http://localhost:8088`](http://localhost:8088) to start your journey. ## Developing -While running, the container server will reload on modification of the superset python and javascript source code. +While running, the container server will reload on modification of the Superset Python and JavaScript source code. Don't forget to reload the page to take the new frontend into account though. ## Production -It is also possible to run Superset in non-development mode: in the `docker-compose.yml` file remove -the volumes needed for development and change the variable `SUPERSET_ENV` to `production`. +It is possible to run Superset in non-development mode by using [`docker-compose-non-dev.yml`](../docker-compose-non-dev.yml). This file excludes the volumes needed for development and uses [`./docker/.env-non-dev`](./.env-non-dev) which sets the variable `SUPERSET_ENV` to `production`. ## Resource Constraints -If you are attempting to build on a Mac and it exits with 137 you need to increase your docker resources. -OSX instructions: https://docs.docker.com/docker-for-mac/#advanced (Search for memory) +If you are attempting to build on macOS and it exits with 137 you need to increase your Docker resources. See instructions [here](https://docs.docker.com/docker-for-mac/#advanced) (search for memory)