Merge pull request #154 from infosiftr/elasticsearch-docs
Elasticsearch docs
This commit is contained in:
commit
bc01719932
|
|
@ -0,0 +1 @@
|
||||||
|
Elasticsearch is a powerful open source search and analytics engine that makes data easy to explore.
|
||||||
|
|
@ -0,0 +1,76 @@
|
||||||
|
# Supported tags and respective `Dockerfile` links
|
||||||
|
|
||||||
|
- [`1.3.7`, `1.3` (*1.3/Dockerfile*)](https://github.com/docker-library/elasticsearch/blob/2fe2cb3aa293a0e75ebc1f72d27cf1aad73d21cb/1.3/Dockerfile)
|
||||||
|
- [`1.4.2`, `1.4`, `1`, `latest` (*1.4/Dockerfile*)](https://github.com/docker-library/elasticsearch/blob/2fe2cb3aa293a0e75ebc1f72d27cf1aad73d21cb/1.4/Dockerfile)
|
||||||
|
|
||||||
|
For more information about this image and its history, please see the [relevant
|
||||||
|
manifest file
|
||||||
|
(`library/elasticsearch`)](https://github.com/docker-library/official-images/blob/master/library/elasticsearch)
|
||||||
|
in the [`docker-library/official-images` GitHub
|
||||||
|
repo](https://github.com/docker-library/official-images).
|
||||||
|
|
||||||
|
# What is Elasticsearch?
|
||||||
|
|
||||||
|
Elasticsearch is a search server based on Lucene. It provides a distributed,
|
||||||
|
multitenant-capable full-text search engine with a RESTful web interface and
|
||||||
|
schema-free JSON documents.
|
||||||
|
|
||||||
|
Elasticsearch is a registered trademark of Elasticsearch BV.
|
||||||
|
|
||||||
|
> [wikipedia.org/wiki/Elasticsearch](https://en.wikipedia.org/wiki/Elasticsearch)
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
# How to use this image
|
||||||
|
|
||||||
|
You can run the default `elasticsearch` command simply:
|
||||||
|
|
||||||
|
docker run -d elasticsearch
|
||||||
|
|
||||||
|
You can also pass in additional flags to `elasticsearch`:
|
||||||
|
|
||||||
|
docker run -d elasticsearch elasticsearch -Des.node.name="TestNode"
|
||||||
|
|
||||||
|
This image comes with a default set of configuration files for `elasticsearch`,
|
||||||
|
but if you want to provide your own set of configuration files, you can do so
|
||||||
|
via a volume mounted at `/usr/share/elasticsearch/config`:
|
||||||
|
|
||||||
|
docker run -d -v "$PWD/config":/usr/share/elasticsearch/config elasticsearch
|
||||||
|
|
||||||
|
This image is configured with a volume at `/usr/share/elasticsearch/data` to
|
||||||
|
hold the persisted index data. Use that path if you would like to keep the data
|
||||||
|
in a mounted volume:
|
||||||
|
|
||||||
|
docker run -d -v "$PWD/esdata":/usr/share/elasticsearch/data elasticsearch
|
||||||
|
|
||||||
|
# License
|
||||||
|
|
||||||
|
View [license information](https://github.com/elasticsearch/elasticsearch/blob/66b5ed86f7adede8102cd4d979b9f4924e5bd837/LICENSE.txt) for the software contained in this image.
|
||||||
|
|
||||||
|
# Supported Docker versions
|
||||||
|
|
||||||
|
This image is officially supported on Docker version 1.4.1.
|
||||||
|
|
||||||
|
Support for older versions (down to 1.0) is provided on a best-effort basis.
|
||||||
|
|
||||||
|
# User Feedback
|
||||||
|
|
||||||
|
## Issues
|
||||||
|
|
||||||
|
If you have any problems with or questions about this image, please contact us
|
||||||
|
through a [GitHub issue](https://github.com/docker-library/elasticsearch/issues).
|
||||||
|
|
||||||
|
You can also reach many of the official image maintainers via the
|
||||||
|
`#docker-library` IRC channel on [Freenode](https://freenode.net).
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
You are invited to contribute new features, fixes, or updates, large or small;
|
||||||
|
we are always thrilled to receive pull requests, and do our best to process them
|
||||||
|
as fast as we can.
|
||||||
|
|
||||||
|
Before you start to code, we recommend discussing your plans
|
||||||
|
through a [GitHub issue](https://github.com/docker-library/elasticsearch/issues), especially for more ambitious
|
||||||
|
contributions. This gives other contributors a chance to point you in the right
|
||||||
|
direction, give you feedback on your design, and help you find out if someone
|
||||||
|
else is working on the same thing.
|
||||||
|
|
@ -0,0 +1,33 @@
|
||||||
|
# What is Elasticsearch?
|
||||||
|
|
||||||
|
Elasticsearch is a search server based on Lucene. It provides a distributed,
|
||||||
|
multitenant-capable full-text search engine with a RESTful web interface and
|
||||||
|
schema-free JSON documents.
|
||||||
|
|
||||||
|
Elasticsearch is a registered trademark of Elasticsearch BV.
|
||||||
|
|
||||||
|
> [wikipedia.org/wiki/Elasticsearch](https://en.wikipedia.org/wiki/Elasticsearch)
|
||||||
|
|
||||||
|
%%LOGO%%
|
||||||
|
|
||||||
|
# How to use this image
|
||||||
|
|
||||||
|
You can run the default `elasticsearch` command simply:
|
||||||
|
|
||||||
|
docker run -d elasticsearch
|
||||||
|
|
||||||
|
You can also pass in additional flags to `elasticsearch`:
|
||||||
|
|
||||||
|
docker run -d elasticsearch elasticsearch -Des.node.name="TestNode"
|
||||||
|
|
||||||
|
This image comes with a default set of configuration files for `elasticsearch`,
|
||||||
|
but if you want to provide your own set of configuration files, you can do so
|
||||||
|
via a volume mounted at `/usr/share/elasticsearch/config`:
|
||||||
|
|
||||||
|
docker run -d -v "$PWD/config":/usr/share/elasticsearch/config elasticsearch
|
||||||
|
|
||||||
|
This image is configured with a volume at `/usr/share/elasticsearch/data` to
|
||||||
|
hold the persisted index data. Use that path if you would like to keep the data
|
||||||
|
in a mounted volume:
|
||||||
|
|
||||||
|
docker run -d -v "$PWD/esdata":/usr/share/elasticsearch/data elasticsearch
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
View [license information](https://github.com/elasticsearch/elasticsearch/blob/66b5ed86f7adede8102cd4d979b9f4924e5bd837/LICENSE.txt) for the software contained in this image.
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 63 KiB |
Loading…
Reference in New Issue