Skip to content

Commit

Permalink
Update README.md for Docker testing
Browse files Browse the repository at this point in the history
  • Loading branch information
enqueue authored Mar 15, 2019
1 parent 5849e23 commit 31b877f
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,40 @@ MetaBase driver for the ClickHouse database

# Testing

:warning: _This driver is in an early development stage and we would caution against using it in your production environment_ :warning:

h2. Building from Source

Please refer to the extensive documentation available in the MetaBase Wiki: [Writing A Driver](https://github.com/metabase/metabase/wiki/Writing-A-Driver)

1. Clone [metabase repository](https://github.com/metabase/metabase)
2. Clone this repository, and follow [the instructions for building the driver](https://github.com/metabase/metabase/wiki/Writing-a-Driver:-Packaging-a-Driver-&-Metabase-Plugin-Basics). Alternatively, download a pre-release jar.
3. Copy `clickhouse.metabase-driver.jar` into your MetaBase `plugins` directory
4. Start MetaBase, e.g. by invoking `lein run` in your MetaBase directory.

:warning: _This driver is in an early development stage and we would caution against using it in your production environment_ :warning:
h2. Do the Docker Dance

In an empty directory, create your Dockerfile, e.g. `Dockerfile-clickhouse`

```
FROM metabase/metabase-head:latest
ADD https://github.com/enqueue/metabase-clickhouse-driver/releases/download/v0.1/clickhouse.metabase-driver.jar /app/plugins/
```

Assemble

```
docker build -f Dockerfile-clickhouse -t foo/metabase-with-clickhouse
```

Run

```
docker run --rm -d=false -p 3000:3000 --name metabase foo/metabase-with-clickhouse
```

Please refer to [the fine MetaBase operations manual](https://www.metabase.com/docs/latest/operations-guide/running-metabase-on-docker.html) to find out how to operate a dockerized MetaBase with a regular database.


# Contributing
* Report any issues you encounter
Expand Down

0 comments on commit 31b877f

Please sign in to comment.