diff --git a/README.md b/README.md index 3a429a27d..b144c4fc0 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,8 @@ Docker image for [AirBnB's Superset](https://github.com/airbnb/superset). Run the superset demo by entering this command into your console: ```bash +git clone git@github.com:amancevice/superset.git +cd superset docker-compose up -d docker-compose exec superset demo ``` @@ -23,7 +25,7 @@ Log in with the credentials you just created. ## Versions -This repo is tagged in parallel with superset. Pulling `amancevice/superset:0.10.0` will fetch the image of this repository running superset version `0.10.0`. As it is an automated build, commits to the master branch of this repository trigger a re-build of the `latest` tag, while tagging master triggers a versioned build. It is possible that the `latest` tag includes new deployment-specific features but will usually be in sync with the latest semantic version. +This repo is tagged in parallel with superset. Pulling `amancevice/superset:0.13.1` will fetch the image of this repository running superset version `0.13.1`. As it is an automated build, commits to the master branch of this repository trigger a re-build of the `latest` tag, while tagging master triggers a versioned build. It is possible that the `latest` tag includes new deployment-specific features but will usually be in sync with the latest semantic version. ## Database Setup @@ -33,12 +35,12 @@ Determine where you will store Caravel's database; choose `SQLite`, `MySQL`, `Po #### SQLite -If Caravel's database is created using SQLite the db file should be mounted from the host machine. In this example we will store a SQLite DB on our host machine in `~/superset/superset.db` and mount the directory to `/home/superset/db` in the container. +If Caravel's database is created using SQLite the db file should be mounted from the host machine. In this example we will store a SQLite DB on our host machine in `~/superset/superset.db` and mount the directory to `/home/superset/.superset` in the container. ```bash docker run --detach --name superset \ --env SECRET_KEY="mySUPERsecretKEY" \ - --env SQLALCHEMY_DATABASE_URI="sqlite:////home/superset/db/superset.db" \ + --env SQLALCHEMY_DATABASE_URI="sqlite:////home/superset/.superset/superset.db" \ --publish 8088:8088 \ --volume ~/superset:/home/superset/db \ amancevice/superset @@ -117,13 +119,13 @@ A custom configuration can be accomplished through mounting a Caravel config to * `CSRF_ENABLED` * `DEBUG` -Additional environmental variables prefixed with `CARAVEL_` will also be passed to the superset configuration (without the `CARAVEL_` prefix). See the [superset configuration file](https://github.com/airbnb/superset/blob/master/superset/config.py) for a list of available configuration keys. +Additional environmental variables prefixed with `SUPERSET_` will also be passed to the superset configuration (without the `SUPERSET_` prefix). See the [superset configuration file](https://github.com/airbnb/superset/blob/master/superset/config.py) for a list of available configuration keys. For example, the following command will deploy superset with the [`LOG_LEVEL`](https://github.com/airbnb/superset/blob/master/superset/config.py) variable set in the superset configuration: ```bash docker run --detach --name superset \ - --env CARAVEL_LOG_LEVEL="INFO" \ + --env SUPERSET_LOG_LEVEL="INFO" \ --publish 8088:8088 \ amancevice/superset ```