root
/
elasticsearch
mirror of https://github.com/elastic/elasticsearch.git
1
0
Fork 0
Code Issues Actions 1 Packages Projects Releases Wiki Activity
elasticsearch/README.asciidoc

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

91 lines
2.6 KiB
Plaintext
Raw Normal View History

[DOCS] Convert main README to asciidoc (#50303) Converts the main README file to asciidoc. Also includes the following changes: * Mentioning Slack instead of IRC * Removed mentioning of native java API, HTTP should be used * Removed java as a installed requirement
2019-12-20 00:53:09 +08:00
= Elasticsearch
initial commit
2010-02-08 21:30:06 +08:00
[DOCS] Refactor quick start guide and README (#71331) Changes: * Refactors the "Getting Started" content down to one page. * Refactors the README to reduce duplicated content and better mirror Kibana's. * Focuses the quick start on time series data, including data streams and runtime fields. * Streamlines self-managed install instructions to Docker. Co-authored-by: debadair <debadair@elastic.co>
2021-04-20 21:32:21 +08:00
Elasticsearch is the distributed, RESTful search and analytics engine at the
heart of the https://www.elastic.co/products[Elastic Stack]. You can use
Elasticsearch to store, search, and manage data for:
initial commit
2010-02-08 21:30:06 +08:00
[DOCS] Refactor quick start guide and README (#71331) Changes: * Refactors the "Getting Started" content down to one page. * Refactors the README to reduce duplicated content and better mirror Kibana's. * Focuses the quick start on time series data, including data streams and runtime fields. * Streamlines self-managed install instructions to Docker. Co-authored-by: debadair <debadair@elastic.co>
2021-04-20 21:32:21 +08:00
* Logs
* Metrics
* A search backend
* Application monitoring
* Endpoint security
initial commit
2010-02-08 21:30:06 +08:00
[DOCS] Refactor quick start guide and README (#71331) Changes: * Refactors the "Getting Started" content down to one page. * Refactors the README to reduce duplicated content and better mirror Kibana's. * Focuses the quick start on time series data, including data streams and runtime fields. * Streamlines self-managed install instructions to Docker. Co-authored-by: debadair <debadair@elastic.co>
2021-04-20 21:32:21 +08:00
\... and more!
initial commit
2010-02-08 21:30:06 +08:00
[DOCS] Refactor quick start guide and README (#71331) Changes: * Refactors the "Getting Started" content down to one page. * Refactors the README to reduce duplicated content and better mirror Kibana's. * Focuses the quick start on time series data, including data streams and runtime fields. * Streamlines self-managed install instructions to Docker. Co-authored-by: debadair <debadair@elastic.co>
2021-04-20 21:32:21 +08:00
To learn more about Elasticsearch's features and capabilities, see our
https://www.elastic.co/products/elasticsearch[product page].
initial commit
2010-02-08 21:30:06 +08:00
[DOCS] Refactor quick start guide and README (#71331) Changes: * Refactors the "Getting Started" content down to one page. * Refactors the README to reduce duplicated content and better mirror Kibana's. * Focuses the quick start on time series data, including data streams and runtime fields. * Streamlines self-managed install instructions to Docker. Co-authored-by: debadair <debadair@elastic.co>
2021-04-20 21:32:21 +08:00
[[get-started]]
== Get started
initial commit
2010-02-08 21:30:06 +08:00
[DOCS] Refactor quick start guide and README (#71331) Changes: * Refactors the "Getting Started" content down to one page. * Refactors the README to reduce duplicated content and better mirror Kibana's. * Focuses the quick start on time series data, including data streams and runtime fields. * Streamlines self-managed install instructions to Docker. Co-authored-by: debadair <debadair@elastic.co>
2021-04-20 21:32:21 +08:00
The simplest way to set up Elasticsearch is to create a managed deployment with
https://www.elastic.co/cloud/as-a-service[Elasticsearch Service on Elastic
Cloud].
initial commit
2010-02-08 21:30:06 +08:00
[DOCS] Refactor quick start guide and README (#71331) Changes: * Refactors the "Getting Started" content down to one page. * Refactors the README to reduce duplicated content and better mirror Kibana's. * Focuses the quick start on time series data, including data streams and runtime fields. * Streamlines self-managed install instructions to Docker. Co-authored-by: debadair <debadair@elastic.co>
2021-04-20 21:32:21 +08:00
If you prefer to install and manage Elasticsearch yourself, you can download
the latest version from
https://www.elastic.co/downloads/elasticsearch[elastic.co/downloads/elasticsearch].
Docs: Add a Requirements section to the README mentioning recent Java Closes #10858
2015-04-29 20:32:16 +08:00
[DOCS] Refactor quick start guide and README (#71331) Changes: * Refactors the "Getting Started" content down to one page. * Refactors the README to reduce duplicated content and better mirror Kibana's. * Focuses the quick start on time series data, including data streams and runtime fields. * Streamlines self-managed install instructions to Docker. Co-authored-by: debadair <debadair@elastic.co>
2021-04-20 21:32:21 +08:00
For more installation options, see the
https://www.elastic.co/guide/en/elasticsearch/reference/current/install-elasticsearch.html[Elasticsearch installation
documentation].
initial commit
2010-02-08 21:30:06 +08:00
[DOCS] Refactor quick start guide and README (#71331) Changes: * Refactors the "Getting Started" content down to one page. * Refactors the README to reduce duplicated content and better mirror Kibana's. * Focuses the quick start on time series data, including data streams and runtime fields. * Streamlines self-managed install instructions to Docker. Co-authored-by: debadair <debadair@elastic.co>
2021-04-20 21:32:21 +08:00
[[upgrade]]
== Upgrade
[DOCS] Add more run options to README (#70607) Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
2021-03-25 21:31:28 +08:00
[DOCS] Refactor quick start guide and README (#71331) Changes: * Refactors the "Getting Started" content down to one page. * Refactors the README to reduce duplicated content and better mirror Kibana's. * Focuses the quick start on time series data, including data streams and runtime fields. * Streamlines self-managed install instructions to Docker. Co-authored-by: debadair <debadair@elastic.co>
2021-04-20 21:32:21 +08:00
To upgrade from an earlier version of Elasticsearch, see the
https://www.elastic.co/guide/en/elasticsearch/reference/current/setup-upgrade.html[Elasticsearch upgrade
documentation].
initial commit
2010-02-08 21:30:06 +08:00
[DOCS] Refactor quick start guide and README (#71331) Changes: * Refactors the "Getting Started" content down to one page. * Refactors the README to reduce duplicated content and better mirror Kibana's. * Focuses the quick start on time series data, including data streams and runtime fields. * Streamlines self-managed install instructions to Docker. Co-authored-by: debadair <debadair@elastic.co>
2021-04-20 21:32:21 +08:00
[[build-source]]
== Build from source
initial commit
2010-02-08 21:30:06 +08:00
[DOCS] Convert main README to asciidoc (#50303) Converts the main README file to asciidoc. Also includes the following changes: * Mentioning Slack instead of IRC * Removed mentioning of native java API, HTTP should be used * Removed java as a installed requirement
2019-12-20 00:53:09 +08:00
Elasticsearch uses https://gradle.org[Gradle] for its build system.
README: Fixed typo and formatting in the „Building from Source” chapter
2011-04-21 15:43:43 +08:00
[DOCS] Refactor quick start guide and README (#71331) Changes: * Refactors the "Getting Started" content down to one page. * Refactors the README to reduce duplicated content and better mirror Kibana's. * Focuses the quick start on time series data, including data streams and runtime fields. * Streamlines self-managed install instructions to Docker. Co-authored-by: debadair <debadair@elastic.co>
2021-04-20 21:32:21 +08:00
To build a distribution for your local OS and print its output location upon
[DOCS] Minor fixes to README.asciidoc
2020-11-03 07:00:36 +08:00
completion, run:
[DOCS] Fix local build directory in README.asciidoc (#64408) Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-11-02 23:13:05 +08:00
----
[DOCS] Refactor quick start guide and README (#71331) Changes: * Refactors the "Getting Started" content down to one page. * Refactors the README to reduce duplicated content and better mirror Kibana's. * Focuses the quick start on time series data, including data streams and runtime fields. * Streamlines self-managed install instructions to Docker. Co-authored-by: debadair <debadair@elastic.co>
2021-04-20 21:32:21 +08:00
./gradlew localDistro
[DOCS] Fix local build directory in README.asciidoc (#64408) Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-11-02 23:13:05 +08:00
----
README: Fixed typo and formatting in the „Building from Source” chapter
2011-04-21 15:43:43 +08:00
[DOCS] Minor fixes to README.asciidoc
2020-11-03 07:00:36 +08:00
To build a distribution for another platform, run the related command:
[DOCS] Fix local build directory in README.asciidoc (#64408) Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-11-02 23:13:05 +08:00
----
./gradlew :distribution:archives:linux-tar:assemble
./gradlew :distribution:archives:darwin-tar:assemble
./gradlew :distribution:archives:windows-zip:assemble
----
[DOCS] Minor fixes to README.asciidoc
2020-11-03 07:00:36 +08:00
To build distributions for all supported platforms, run:
----
./gradlew assemble
----
[DOCS] Refactor quick start guide and README (#71331) Changes: * Refactors the "Getting Started" content down to one page. * Refactors the README to reduce duplicated content and better mirror Kibana's. * Focuses the quick start on time series data, including data streams and runtime fields. * Streamlines self-managed install instructions to Docker. Co-authored-by: debadair <debadair@elastic.co>
2021-04-20 21:32:21 +08:00
Distributions are output to `distributions/archives`.
To run the test suite, see xref:TESTING.asciidoc[TESTING].
[[docs]]
== Documentation
For the complete Elasticsearch documentation visit
https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html[elastic.co].
For information about our documentation processes, see the
xref:docs/README.asciidoc[docs README].
[[contribute]]
== Contribute
For contribution guidelines, see xref:CONTRIBUTING.md[CONTRIBUTING].
initial commit
2010-02-08 21:30:06 +08:00
[DOCS] Refactor quick start guide and README (#71331) Changes: * Refactors the "Getting Started" content down to one page. * Refactors the README to reduce duplicated content and better mirror Kibana's. * Focuses the quick start on time series data, including data streams and runtime fields. * Streamlines self-managed install instructions to Docker. Co-authored-by: debadair <debadair@elastic.co>
2021-04-20 21:32:21 +08:00
[[questions]]
== Questions? Problems? Suggestions?
Add TESTING document describing test settings
2013-09-14 01:50:56 +08:00
[DOCS] Refactor quick start guide and README (#71331) Changes: * Refactors the "Getting Started" content down to one page. * Refactors the README to reduce duplicated content and better mirror Kibana's. * Focuses the quick start on time series data, including data streams and runtime fields. * Streamlines self-managed install instructions to Docker. Co-authored-by: debadair <debadair@elastic.co>
2021-04-20 21:32:21 +08:00
* To report a bug or request a feature, create a
https://github.com/elastic/elasticsearch/issues/new/choose[GitHub Issue]. Please
ensure someone else hasn't created an issue for the same topic.
Author: Sean Gallagher Date: Tue Apr 1 12:28:00 2014 Added upgrade.asciidoc and links to it from setup.asciidoc Author: Sean Gallagher Date: Apr 1 2014 Added upgrade.asciidoc Add upgrade instructions Author: Sean Gallagher Date: 4/4/14 Closes issue #5651 Fixed upgrade.asciidoc typo and incorrect usage. Author: Sean Gallagher Date: 4 Apr 2014 Closes 5651
2014-04-02 00:28:08 +08:00
[DOCS] Refactor quick start guide and README (#71331) Changes: * Refactors the "Getting Started" content down to one page. * Refactors the README to reduce duplicated content and better mirror Kibana's. * Focuses the quick start on time series data, including data streams and runtime fields. * Streamlines self-managed install instructions to Docker. Co-authored-by: debadair <debadair@elastic.co>
2021-04-20 21:32:21 +08:00
* Need help using Elasticsearch? Reach out on the
https://discuss.elastic.co[Elastic Forum] or https://ela.st/slack[Slack]. A
fellow community member or Elastic engineer will be happy to help you out.