You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/content/docs/aws/customization/advanced/arm64-support.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ This manifest contains links to a Linux AMD64 as well as a Linux ARM64 image.
12
12
13
13
## Pulling the LocalStack image
14
14
15
-
With the multi-arch Docker manifest, your Docker client (and therefore the [LocalStack CLI](/aws/getting-started/installation/#localstack-cli)) now automatically selects the image according to your platform:
15
+
With the multi-arch Docker manifest, your Docker client (and therefore [`lstk`](/aws/getting-started/installation/#lstk)) now automatically selects the image according to your platform:
Copy file name to clipboardExpand all lines: src/content/docs/aws/developer-tools/cloud-sandbox/ephemeral-instances.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -87,7 +87,7 @@ If you have created a Cloud Pod from an older version of LocalStack, you need to
87
87
88
88
## Ephemeral Instances CLI
89
89
90
-
The Ephemeral Instances CLI is included in the [LocalStack CLI installation](/aws/getting-started/installation/#install-localstack-cli), so no additional installations are needed to start using it.
90
+
The Ephemeral Instances CLI is included in the [LocalStack CLI](/aws/developer-tools/running-localstack/localstack-cli/#installation), so no additional installations are needed to start using it.
91
91
If you're a licensed user, setting the `LOCALSTACK_AUTH_TOKEN` as an environment variable is recommended to access all features of the Ephemeral Instances CLI.
92
92
93
93
Access the Ephemeral Instances CLI by running the `localstack ephemeral` command from your terminal.
Copy file name to clipboardExpand all lines: src/content/docs/aws/developer-tools/running-localstack/lstk.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ Running `lstk` with no arguments takes you through the entire startup flow autom
23
23
## Prerequisites
24
24
25
25
-[Docker](https://docs.docker.com/get-docker/) installed and running.
26
-
- A [LocalStack account](https://www.localstack.cloud/pricing) with a [license](/aws/getting-started/auth-token/#managing-your-license), and `lstk` handles authentication for you (see [Authentication](#authentication)).
26
+
- A [LocalStack account](https://www.localstack.cloud/pricing) with a [license](/aws/getting-started/auth-token/#license-assignment), and `lstk` handles authentication for you (see [Authentication](#authentication)).
Copy file name to clipboardExpand all lines: src/content/docs/aws/developer-tools/security-testing/custom-tls-certificates.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ They all can be summarised as:
30
30
31
31
## Creating a custom docker image
32
32
33
-
If you run LocalStack in a docker container (which includes using [the CLI](/aws/getting-started/installation/#install-localstack-cli), [docker](/aws/getting-started/installation/#docker-compose), [docker-compose](/aws/getting-started/installation/#docker-compose), or [helm](/aws/customization/kubernetes/deploy-helm-chart)), to include a custom TLS root certificate a new docker image should be created.
33
+
If you run LocalStack in a docker container (which includes using [`lstk`](/aws/getting-started/installation/#lstk), [Docker Compose](/aws/getting-started/installation/#docker-compose), or [Helm](/aws/getting-started/installation/#helm-kubernetes)), to include a custom TLS root certificate a new docker image should be created.
34
34
35
35
Create a `Dockerfile` containing the following commands:
Copy file name to clipboardExpand all lines: src/content/docs/aws/developer-tools/snapshots/cloud-pods.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ You can save and load the persistent state of Cloud Pods, you can use the [Cloud
28
28
LocalStack provides a remote storage backend that can be used to store the state of your running application and share it with your team members.
29
29
You can interact with the Cloud Pods over the storage backend via the LocalStack Web Application.
30
30
31
-
Cloud Pods CLI is included in the [LocalStack CLI installation](/aws/getting-started/installation/#install-localstack-cli), so there's no need for additional installations to begin using it.
31
+
Cloud Pods CLI is included in the [LocalStack CLI](/aws/developer-tools/running-localstack/localstack-cli/#installation), so there's no need for additional installations to begin using it.
32
32
If you're a licensed user, we suggest setting the `LOCALSTACK_AUTH_TOKEN` as an environment variable.
33
33
This enables you to access the complete range of LocalStack Cloud Pods features.
34
34
@@ -451,7 +451,7 @@ localstack pod list s3-storage-aws
451
451
452
452
:::note
453
453
Full S3 remotes support is available in the CLI from version 3.2.0.
454
-
If you experience any difficulties, update your [LocalStack CLI](/aws/getting-started/installation/#update-localstack-cli).
454
+
If you experience any difficulties, update your [LocalStack CLI](/aws/developer-tools/running-localstack/localstack-cli/#installation).
Copy file name to clipboardExpand all lines: src/content/docs/aws/getting-started/ai-workflows.mdx
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ This is useful when you want to:
21
21
22
22
There are three common ways to use LocalStack in AI-assisted development:
23
23
24
-
- Use the [LocalStack MCP Server](/aws/tooling/mcp-server/) when your AI assistant supports MCP clients such as Cursor, Claude, Codex, or OpenCode.
24
+
- Use the [LocalStack MCP Server](/aws/developer-tools/running-localstack/mcp-server/) when your AI assistant supports MCP clients such as Cursor, Claude, Codex, or OpenCode.
25
25
- Use [LocalStack Skills](https://github.com/localstack/skills) when you want reusable agent instructions for deploying and testing AWS architectures against LocalStack.
26
26
- Use LocalStack with `tflocal`, `cdklocal`, or `awslocal` when you want the agent to generate infrastructure code or commands that you review and run locally.
The MCP server runs locally and talks to a LocalStack instance. Your AI assistant is the MCP client. For full installation instructions, detailed setup, and the full tool reference, see the [LocalStack MCP Server guide](/aws/tooling/mcp-server/).
51
+
The MCP server runs locally and talks to a LocalStack instance. Your AI assistant is the MCP client. For full installation instructions, detailed setup, and the full tool reference, see the [LocalStack MCP Server guide](/aws/developer-tools/running-localstack/mcp-server/).
52
52
53
53
You need a valid [Auth Token](/aws/getting-started/auth-token/) to configure the server.
54
54
:::
@@ -103,6 +103,6 @@ Before applying changes to AWS, check that:
103
103
104
104
## Next steps
105
105
106
-
- Configure the [LocalStack MCP Server](/aws/tooling/mcp-server/) if your AI assistant supports MCP.
106
+
- Configure the [LocalStack MCP Server](/aws/developer-tools/running-localstack/mcp-server/) if your AI assistant supports MCP.
107
107
- Review [LocalStack Skills](https://github.com/localstack/skills) for reusable agent workflows.
108
108
- Browse the [LocalStack for AWS services](/aws/services/) reference, or check the [Getting Started FAQ](/aws/getting-started/faq/) for common setup questions.
See the [GitHub Actions guide](/aws/integrations/continuous-integration/github-actions/) for the full setup.
61
+
See the [GitHub Actions guide](/aws/ci-pipelines/github-actions/) for the full setup.
62
62
63
63
</TabItem>
64
64
<TabItem label="CircleCI">
@@ -88,7 +88,7 @@ For brevity, these snippets show only the LocalStack startup shape. Apart from t
88
88
localstack wait -t 60
89
89
```
90
90
91
-
See the [CircleCI guide](/aws/integrations/continuous-integration/circleci/) for the full setup.
91
+
See the [CircleCI guide](/aws/ci-pipelines/circleci/) for the full setup.
92
92
93
93
</TabItem>
94
94
<TabItem label="Bitbucket">
@@ -116,7 +116,7 @@ For brevity, these snippets show only the LocalStack startup shape. Apart from t
116
116
- localstack wait -t 60
117
117
```
118
118
119
-
See the [Bitbucket Pipelines guide](/aws/integrations/continuous-integration/bitbucket/) for the full setup.
119
+
See the [Bitbucket Pipelines guide](/aws/ci-pipelines/bitbucket/) for the full setup.
120
120
121
121
</TabItem>
122
122
<TabItem label="CodeBuild">
@@ -133,7 +133,7 @@ For brevity, these snippets show only the LocalStack startup shape. Apart from t
133
133
- localstack wait -t 30
134
134
```
135
135
136
-
See the [CodeBuild guide](/aws/integrations/continuous-integration/codebuild/) for the full setup.
136
+
See the [CodeBuild guide](/aws/ci-pipelines/codebuild/) for the full setup.
137
137
138
138
</TabItem>
139
139
<TabItem label="GitLab CI">
@@ -162,7 +162,7 @@ For brevity, these snippets show only the LocalStack startup shape. Apart from t
162
162
- awslocal s3 mb s3://test-bucket
163
163
```
164
164
165
-
See the [GitLab CI guide](/aws/integrations/continuous-integration/gitlab-ci/) for the full setup.
165
+
See the [GitLab CI guide](/aws/ci-pipelines/gitlab-ci/) for the full setup.
166
166
167
167
</TabItem>
168
168
<TabItem label="Travis CI">
@@ -183,12 +183,12 @@ For brevity, these snippets show only the LocalStack startup shape. Apart from t
183
183
- localstack wait -t 30
184
184
```
185
185
186
-
See the [Travis CI guide](/aws/integrations/continuous-integration/travis-ci/) for the full setup.
186
+
See the [Travis CI guide](/aws/ci-pipelines/travis-ci/) for the full setup.
187
187
188
188
</TabItem>
189
189
</Tabs>
190
190
191
-
You can also start from the [CI integrations overview](/aws/integrations/continuous-integration/) if you want a broader explanation of the CI workflow.
191
+
You can also start from the [CI integrations overview](/aws/ci-pipelines/) if you want a broader explanation of the CI workflow.
192
192
193
193
## Authentication in CI
194
194
@@ -202,9 +202,9 @@ Most CI jobs should start with a clean LocalStack instance. A fresh instance mak
202
202
203
203
If your pipeline needs state across jobs or workflow stages, use one of the state management options documented outside this getting started page:
204
204
205
-
- [Cloud Pods](/aws/capabilities/state-management/cloud-pods/) to save and restore named LocalStack state snapshots.
206
-
- [State export and import](/aws/capabilities/state-management/export-import-state/) to move state through artifacts or caches.
207
-
- [Persistence](/aws/capabilities/state-management/persistence/) when the same runner keeps a mounted LocalStack volume.
205
+
- [Cloud Pods](/aws/developer-tools/snapshots/cloud-pods/) to save and restore named LocalStack state snapshots.
206
+
- [State export and import](/aws/developer-tools/snapshots/export-import-state/) to move state through artifacts or caches.
207
+
- [Persistence](/aws/developer-tools/snapshots/persistence/) when the same runner keeps a mounted LocalStack volume.
Download the binary for your platform from the [GitHub Releases](https://github.com/localstack/lstk/releases) and add it to your `PATH`.
34
+
Download the binary for your platform from the [GitHub
35
+
Releases](https://github.com/localstack/lstk/releases) and add it to your
36
+
`PATH`.
42
37
</TabItem>
43
38
</Tabs>
44
39
@@ -138,78 +133,70 @@ Install the [official extension](https://hub.docker.com/extensions/localstack/lo
138
133
139
134
## Troubleshooting
140
135
141
-
#### The LocalStack CLI installation is successful, but I cannot execute `localstack`
142
-
143
-
If you can successfully install LocalStack using `pip` but you cannot use it in your terminal, you most likely haven't set up your operating system's / terminal's `PATH` variable (in order to tell them where to find programs installed via `pip`).
136
+
Installation issues typically fall into one of three areas: getting your chosen install method working, activating your license, or reaching LocalStack over the network. This section will guide you to the appropriate guide that contains detailed fixes based on your installation method.
144
137
145
-
- If you are using Windows, you can enable the `PATH` configuration when installing Python, [as described in the official docs of Python](https://docs.python.org/3/using/windows.html#finding-the-python-executable).
146
-
- If you are using a MacOS or Linux operating system, please make sure that the `PATH` is correctly set up - either system wide, or in your terminal.
138
+
### lstk
147
139
148
-
As a workaround you can call the LocalStack CLI python module directly:
149
-
150
-
```bash
151
-
python3 -m localstack.cli.main
152
-
```
140
+
If you installed via [`lstk`](#lstk) and LocalStack fails to start, authenticate, or pull its image, see [lstk troubleshooting](/aws/developer-tools/running-localstack/lstk/#troubleshooting).
153
141
154
-
#### The `localstack` CLI does not start the LocalStack container
142
+
For first-run authentication (browser login, keyring tokens, or `LOCALSTACK_AUTH_TOKEN` in CI), refer to [Authentication](/aws/developer-tools/running-localstack/lstk/#authentication) and the [Auth Token guide](/aws/getting-started/auth-token/).
155
143
156
-
If you are using the `localstack` CLI to start LocalStack, but the container is not starting, please check the following:
144
+
### Docker Compose and Docker CLI
157
145
158
-
- Uncheck the **Use kernel networking for UDP** option in Docker Desktop (**Settings** → **Resources** → **Network**) or follow the steps in our [documentation](/aws/customization/networking/dns-server#system-dns-configuration) to disable it.
159
-
- Start LocalStack with a specific DNS address:
146
+
If you started LocalStack with [Docker Compose](#docker-compose) or the [Docker CLI](#docker-cli):
160
147
161
-
```bash
162
-
DNS_ADDRESS=0 localstack start
163
-
```
148
+
- **License or credential errors**: see [Auth Token troubleshooting](/aws/getting-started/auth-token/#troubleshooting).
149
+
- **Container exits during startup, proxy/DNS/TLS issues, or port conflicts**: see [Startup Troubleshooting FAQs](/aws/getting-started/faq/#startup-troubleshooting-faqs).
150
+
- **DNS server or port conflicts**: see the [DNS Server guide](/aws/customization/networking/dns-server/).
164
151
165
-
- Remove port 53 as indicated in our [standard `docker-compose.yml` file](https://github.com/localstack/localstack/blob/main/docker-compose-pro.yml).
152
+
Ensure you have exported `LOCALSTACK_AUTH_TOKEN` in your shell before running `dockercompose up` or `docker run`.
166
153
167
-
#### How should I access the LocalStack logs on my local machine?
154
+
### View logs
168
155
169
-
You can now avail logging output and error reporting using LocalStack logs.
170
-
To access the logs, run the following command:
156
+
Stream container logs using the command that matches your install method:
171
157
172
158
<Tabs>
173
159
<TabItem label="lstk">
160
+
174
161
```bash
175
162
lstk logs
176
163
```
177
-
</TabItem>
178
-
</Tabs>
179
164
180
-
AWS requests are now logged uniformly in the INFO log level (set by default or when `DEBUG=0`).
181
-
The format is:
165
+
For `lstk` CLI diagnostics (separate from container logs), see [Logging](/aws/developer-tools/running-localstack/lstk/#logging).
Ensure that the diagnostic endpoint is run after you have tried reproducing the affected task.
206
-
After running the task, run the diagnostic endpoint and share the archive file with your team members or LocalStack Support.
190
+
The deployment name follows your Helm release name (default: `localstack`).
191
+
192
+
</TabItem>
193
+
</Tabs>
207
194
208
-
#### My application cannot reach LocalStack over the network
195
+
To enable verbose startup logging, capture logs from a failed container, or share a diagnose bundle with support, see [How do I capture and share LocalStack container logs for troubleshooting?](/aws/getting-started/faq/#how-do-i-capture-and-share-localstack-container-logs-for-troubleshooting).
209
196
210
-
We have extensive network troubleshooting documentation available [here](/aws/customization/networking/).
197
+
### Network connectivity
211
198
212
-
If this does not solve your problem then please [reach out to LocalStack Support](/aws/help-support/get-help/).
199
+
If your application cannot reach LocalStack after installation, see the [networking documentation](/aws/customization/networking/).
Copy file name to clipboardExpand all lines: src/content/docs/aws/getting-started/local-development.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -271,7 +271,7 @@ Stop your LocalStack container to remove all emulated resources. LocalStack is e
271
271
272
272
{/* prettier-ignore-end */}
273
273
274
-
To persist resource state, like S3 buckets or DynamoDB tables, across restarts, check out our [state management tools](/aws/capabilities/state-management/).
274
+
To persist resource state, like S3 buckets or DynamoDB tables, across restarts, check out our [state management tools](/aws/developer-tools/snapshots/).
0 commit comments