diff --git a/crate/README-short.txt b/crate/README-short.txt index 3a00ad4e2..890b234a4 100644 --- a/crate/README-short.txt +++ b/crate/README-short.txt @@ -1 +1 @@ -Crate is a shared nothing, fully searchable, SQL database with the NoSQL goodies. +Crate is a shared nothing, fully searchable, SQL database with the NoSQL goodies. \ No newline at end of file diff --git a/crate/content.md b/crate/content.md index 3ba86e988..69a13a056 100644 --- a/crate/content.md +++ b/crate/content.md @@ -6,20 +6,30 @@ Crate allows to query and compute data with SQL in real time by providing a dist %%LOGO%% +## Crate on Docker + +Learn more about Crate and Docker and visit our [Docker page](https://crate.io/c/docker) at [crate.io](https://crate.io). You can also contact us on [Slack](https://crate.io/docs/support/slackin/). + ## How to use this image +Simply run the latest Crate version in a Docker container with the following command. Crate ships with an [Admin UI](https://crate.io/docs/connect/admin_ui/) that provides an overview of your cluster, nodes, tables and much more. With the above command it is accessible via port `4200`. + ```console $ docker run -d -p 4200:4200 -p 4300:4300 crate:latest ``` ### Attach persistent data directory +If you want to attach a persistent data directory, add the following parameter. + ```console $ docker run -d -p 4200:4200 -p 4300:4300 -v :/data crate ``` ### Use custom Crate configuration +Use the following parameter to provide your custom [Crate configuration file](https://crate.io/docs/reference/configuration.html). + ```console $ docker run -d -p 4200:4200 -p 4300:4300 crate -Des.config=/path/to/crate.yml ``` @@ -30,8 +40,6 @@ Any configuration settings may be specified upon startup using the `-D` option p $ docker run -d -p 4200:4200 -p 4300:4300 crate crate -Des.cluster.name=cluster ``` -For further configuration options please refer to the [Configuration](https://crate.io/docs/stable/configuration.html) section of the online documentation. - ### Environment To set environment variables for Crate Data you need to use the `--env` option when starting the docker image. diff --git a/crate/logo.png b/crate/logo.png index 13a9a20ca..2d5797a22 100644 Binary files a/crate/logo.png and b/crate/logo.png differ diff --git a/crate/user-feedback.md b/crate/user-feedback.md index 9ea85124c..59602b470 100644 --- a/crate/user-feedback.md +++ b/crate/user-feedback.md @@ -2,11 +2,13 @@ Documentation for this image is stored in the [`%%REPO%%/` directory](https://github.com/docker-library/docs/tree/master/%%REPO%%) of the [`docker-library/docs` GitHub repo](https://github.com/docker-library/docs). Be sure to familiarize yourself with the [repository's `REAMDE.md` file](https://github.com/docker-library/docs/blob/master/README.md) before attempting a pull request. +Visit [Crate on Docker](https://crate.io/docs/install/containers/docker/) and get further documentation about how to get started with Crate. + ## Issues If you have any problems with or questions about this image, please contact us %%MAILING-LIST%% through a [GitHub issue](%%GITHUB-REPO%%/issues). -If you have any questions or suggestions we would be very happy to help you. So, feel free to join our public room on [HipChat](https://www.hipchat.com/g7Pc2CYwi). +If you have any questions or suggestions we would be very happy to help you. So, feel free to join our public room on [Slack](https://crate.io/docs/support/slackin/). For further information and official contact please visit [https://crate.io](https://crate.io).