Skip to content

Commit

Permalink
Clarify installation page (#828)
Browse files Browse the repository at this point in the history
  • Loading branch information
simonrw authored Sep 19, 2023
1 parent bc8fb5a commit 7b7b20a
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 8 deletions.
6 changes: 4 additions & 2 deletions content/en/getting-started/api-key.md
Original file line number Diff line number Diff line change
Expand Up @@ -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=<YOUR_API_KEY>
localstack start -d
localstack start
{{< /tab >}}
{{< tab header="Windows" lang="powershell" >}}
$env:LOCALSTACK_API_KEY="<YOUR_API_KEY>"; localstack start -d
$env:LOCALSTACK_API_KEY="<YOUR_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" >}}
Expand Down
41 changes: 35 additions & 6 deletions content/en/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -23,13 +26,22 @@ $ brew install localstack/tap/localstack-cli
<details>
<summary>Alternative: Binary Download</summary>
<p>
Alternatively, you can just download the respective binary for your architecture directly:<br>
Alternatively, you can download the respective binary for your architecture directly:<br>
{{< cli-binary-download os="macos" >}}
</p>
<p>
or use this <code>curl</code> command:
</p>
<p>
{{< 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 >}}
</p>
<p>
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 >}}
</p>
</details>
Expand Down Expand Up @@ -58,13 +70,30 @@ If you have problems with permissions in MacOS X Sierra, install with `python3 -

{{< tab header="Linux" >}}
<p>
You can just download the respective binary for your architecture directly:<br>
You can download the respective binary for your architecture directly:<br>
{{< cli-binary-download os="linux" >}}
</p>
<p>
or use this <code>curl</code> command:
</p>
<p>
For <code>x86-64</code>:
{{< 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 >}}
</p>
<p>
Or <code>ARM64</code>:
{{< 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 >}}
</p>
<p>
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 >}}
</p>

Expand Down Expand Up @@ -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" >}}<br/>
Then extract the archive and execute the binary using Powershell.

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 7b7b20a

Please sign in to comment.