-
Notifications
You must be signed in to change notification settings - Fork 165
Simplify start-local.md #981
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
25 changes: 9 additions & 16 deletions
25
deploy-manage/deploy/self-managed/_snippets/start-local.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,46 +1,39 @@ | ||
| ::::{warning} | ||
| **DO NOT USE THESE INSTRUCTIONS FOR PRODUCTION DEPLOYMENTS** | ||
|
|
||
| The instructions on this page are for **local development only**. Do not use this configuration for production deployments, because it is not secure. Refer to [](/get-started/deployment-options.md) for a list of production deployment options. | ||
|
|
||
| The instructions on this page are for **local development only**. Do not use this configuration for production deployments, because it is not secure. Refer to [deployment options](/get-started/deployment-options.md) for a list of production deployment options. | ||
| :::: | ||
|
|
||
| Quickly set up {{es}} and {{kib}} in Docker for local development or testing, using the [`start-local` script](https://github.com/elastic/start-local?tab=readme-ov-file#-try-elasticsearch-and-kibana-locally). | ||
| Quickly set up {{es}} and {{kib}} in Docker for local development or testing, using this one-liner in the command line. | ||
|
|
||
| This setup comes with a one-month trial license that includes all Elastic features. After the trial period, the license reverts to **Free and open - Basic**. Refer to [Elastic subscriptions](https://www.elastic.co/subscriptions) for more information. | ||
| :::{info} | ||
| This setup comes with a one-month trial license that includes all Elastic features. | ||
| ::: | ||
|
|
||
| ## Prerequisites [local-dev-prerequisites] | ||
|
|
||
| * If you don’t have Docker installed, [download and install Docker Desktop](https://www.docker.com/products/docker-desktop) for your operating system. | ||
| * If you’re using Microsoft Windows, then install [Windows Subsystem for Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/install). | ||
|
|
||
| ## Run `start-local` script [local-dev-quick-start] | ||
| ## Step 1: Run `start-local` script [local-dev-quick-start] | ||
|
|
||
| To set up {{es}} and {{kib}} locally, run the `start-local` script: | ||
| To set up {{es}} and {{kib}} locally, run the `start-local` script in the command line: | ||
|
|
||
| ```sh | ||
| curl -fsSL https://elastic.co/start-local | sh | ||
| ``` | ||
|
|
||
| This script creates an `elastic-start-local` folder containing configuration files and starts both {{es}} and {{kib}} using Docker. | ||
|
|
||
| After running the script, you can access Elastic services at the following endpoints: | ||
|
|
||
| * **{{es}}**: [http://localhost:9200](http://localhost:9200) | ||
| * **{{kib}}**: [http://localhost:5601](http://localhost:5601) | ||
|
|
||
| The script generates a random password for the `elastic` user, and an API key, stored in the `.env` file. | ||
|
|
||
| ::::{warning} | ||
| This setup is for local testing only. HTTPS is disabled, and Basic authentication is used for {{es}}. For security, {{es}} and {{kib}} are accessible only through `localhost`. | ||
|
|
||
| :::: | ||
| That's it! There's no step 2. | ||
|
|
||
| ## Learn more [local-dev-additional-info] | ||
|
|
||
| For more detailed information about the `start-local` setup, refer to the [README on GitHub](https://github.com/elastic/start-local). Learn about customizing the setup, logging, and more. | ||
|
|
||
|
|
||
| ## Next steps [local-dev-next-steps] | ||
|
|
||
| Use our [quick start guides](https://www.elastic.co/guide/en/elasticsearch/reference/current/quickstart.html) to learn the basics of {{es}}. | ||
| Use our [quick start guides](https://www.elastic.co/guide/en/elasticsearch/reference/current/quickstart.html) to learn the basics of {{es}}. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@leemthompo I wonder if we should continue including the subscriptions link? Was this just trimming off things, or do you have a reason to remove this? (Agree I think we can trim the line down—so maybe just a very simple call-to-action with the subscription link?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
as Enrico mentioned, we're relying on the README as the source of truth, so we can just defer to https://github.com/elastic/start-local/blob/main/README.md#-features
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it's more about the ratio of signal-to-noise on the page than anything else
start-local is a one-line command and we need to remove everything we can to not obfuscate the actual instructions on the page
we've got a big "don't use in production" warning and links to the readme for full details already, so I think this edit makes sense