Skip to content
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.

Sign up for GitHub

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

Clarify installation page #828

Merged
merged 7 commits into from
Sep 19, 2023
Merged

Clarify installation page #828

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
253ece9
Make getting started sections consistent community vs pro
simonrw Sep 18, 2023
4df88f6
Include section on what the CLI does
simonrw Sep 18, 2023
2cf16f3
Remove the word "just"
simonrw Sep 18, 2023
095e586
Add curl example commands
simonrw Sep 18, 2023
4a75d44
Apply suggestions from code review
simonrw Sep 19, 2023
26fd334
Update windows instructions to match linux
simonrw Sep 19, 2023
c79348a
Update curl command to be consistent
simonrw Sep 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions content/en/getting-started/api-key.md
View file
Open in desktop
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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess it makes sense to not start in detached mode here, but then we should also change it in line 36 (instructions for windows).

Copy link
Contributor Author

@simonrw simonrw Sep 19, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was made to be consistent with the community instructions. I'll update the windows docs as well.

{{< /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
View file
Open in desktop
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