From 7b7b20a58928b75bed93c9f01c62db6199330f0e Mon Sep 17 00:00:00 2001 From: Simon Walker Date: Tue, 19 Sep 2023 15:32:31 +0100 Subject: [PATCH] Clarify installation page (#828) --- content/en/getting-started/api-key.md | 6 ++-- content/en/getting-started/installation.md | 41 ++++++++++++++++++---- 2 files changed, 39 insertions(+), 8 deletions(-) diff --git a/content/en/getting-started/api-key.md b/content/en/getting-started/api-key.md index caba0255cc..0f4c7297b5 100644 --- a/content/en/getting-started/api-key.md +++ b/content/en/getting-started/api-key.md @@ -30,13 +30,15 @@ LocalStack expects your API key to be present in the environment variable `LOCAL {{< tabpane >}} {{< tab header="macOS/Linux" lang="shell" >}} export LOCALSTACK_API_KEY= -localstack start -d +localstack start {{< /tab >}} {{< tab header="Windows" lang="powershell" >}} -$env:LOCALSTACK_API_KEY=""; localstack start -d +$env:LOCALSTACK_API_KEY=""; localstack start {{< /tab >}} {{< /tabpane >}} +You can optionally run your LocalStack container in background mode by adding the `-d` flag to the `localstack start` command. + The `localstack` CLI will detect the API key and properly pass it to the LocalStack container. {{< alert title="Note" >}} diff --git a/content/en/getting-started/installation.md b/content/en/getting-started/installation.md index 82f926ee35..b738c6f9b2 100644 --- a/content/en/getting-started/installation.md +++ b/content/en/getting-started/installation.md @@ -14,6 +14,9 @@ cascade: The quickest way get started with LocalStack is by using the LocalStack CLI. It allows you to start LocalStack from your command line. Please make sure that you have a working [`docker` environment](https://docs.docker.com/get-docker/) on your machine before moving on. +The CLI starts and manages the LocalStack docker container. +For alternative methods of managing the LocalStack container, see our [alternative installation instructions]({{< ref "#alternatives" >}}). + {{< tabpane text=true >}} {{< tab header="MacOS" >}} You can install the LocalStack CLI using Brew directly from our official LocalStack tap: @@ -23,13 +26,22 @@ $ brew install localstack/tap/localstack-cli
Alternative: Binary Download

-Alternatively, you can just download the respective binary for your architecture directly:
+Alternatively, you can download the respective binary for your architecture directly:
{{< cli-binary-download os="macos" >}}

+or use this curl command: +

+

+{{< command >}} +$ curl -Lo localstack-cli-{{< localstack-latest-version >}}-darwin-amd64-onefile.tar.gz \ + https://github.com/localstack/localstack-cli/releases/download/v{{< localstack-latest-version >}}/localstack-cli-{{< localstack-latest-version >}}-darwin-amd64-onefile.tar.gz +{{< / command >}} +

+

Then extract the LocalStack CLI from the terminal: {{< command >}} -$ sudo tar xvzf ~/Downloads/localstack-cli-{{< localstack-latest-version >}}-darwin-*-onefile.tar.gz -C /usr/local/bin +$ sudo tar xvzf localstack-cli-{{< localstack-latest-version >}}-darwin-*-onefile.tar.gz -C /usr/local/bin {{< / command >}}

@@ -58,13 +70,30 @@ If you have problems with permissions in MacOS X Sierra, install with `python3 - {{< tab header="Linux" >}}

-You can just download the respective binary for your architecture directly:
+You can download the respective binary for your architecture directly:
{{< cli-binary-download os="linux" >}}

+or use this curl command: +

+

+For x86-64: +{{< command >}} +$ curl -Lo localstack-cli-{{< localstack-latest-version >}}-linux-amd64-onefile.tar.gz \ + https://github.com/localstack/localstack-cli/releases/download/v{{< localstack-latest-version >}}/localstack-cli-{{< localstack-latest-version >}}-linux-amd64-onefile.tar.gz +{{< / command >}} +

+

+Or ARM64: +{{< command >}} +$ curl -Lo localstack-cli-{{< localstack-latest-version >}}-linux-arm64-onefile.tar.gz \ + https://github.com/localstack/localstack-cli/releases/download/v{{< localstack-latest-version >}}/localstack-cli-{{< localstack-latest-version >}}-linux-arm64-onefile.tar.gz +{{< / command >}} +

+

Then extract the LocalStack CLI from the terminal: {{< command >}} -$ sudo tar xvzf ~/Downloads/localstack-cli-{{< localstack-latest-version >}}-linux-*-onefile.tar.gz -C /usr/local/bin +$ sudo tar xvzf localstack-cli-{{< localstack-latest-version >}}-linux-*-onefile.tar.gz -C /usr/local/bin {{< / command >}}

@@ -98,7 +127,7 @@ Do not use `sudo` or the `root` user - LocalStack should be installed and starte {{< tab header="Windows" >}} -You can just download the respective binary for your architecture directly: +You can download the respective binary for your architecture directly: {{< cli-binary-download os="windows" >}}
Then extract the archive and execute the binary using Powershell. @@ -287,7 +316,7 @@ $ localstack config validate ### Docker -You can also just directly start the LocalStack container using the Docker CLI instead of [Docker-Compose]({{< ref "#docker-compose" >}}). +You can also directly start the LocalStack container using the Docker CLI instead of [Docker-Compose]({{< ref "#docker-compose" >}}). This method requires more manual steps and configuration, but it gives you more control over the container settings. #### Prerequisites