Skip to content
This repository was archived by the owner on Aug 7, 2025. It is now read-only.

Commit 3bfaad9

Browse files
authored
add FAQ on Docker image tags (#1078)
* cleanup faq to use one line for each sentence * add FAQ section on docker image tags
1 parent 3eccb37 commit 3bfaad9

File tree

1 file changed

+71
-19
lines changed
  • content/en/getting-started

1 file changed

+71
-19
lines changed

content/en/getting-started/faq.md

Lines changed: 71 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ hide_readingtime: true
1313

1414
### How to update my LocalStack CLI?
1515

16-
If the LocalStack CLI version is heavily outdated, it might lead to issues with container startup and debug commands. If you are using an older version of LocalStack, you can update it by running the following command:
16+
If the LocalStack CLI version is heavily outdated, it might lead to issues with container startup and debug commands.
17+
If you are using an older version of LocalStack, you can update it by running the following command:
1718

1819
{{< command >}}
1920
$ pip install --upgrade localstack localstack-ext
@@ -37,21 +38,51 @@ The primary reason being that some users are behind a corporate firewall or an i
3738

3839
### How should I use the latest LocalStack Docker images?
3940

40-
To use the latest LocalStack Docker images, you either run `docker pull localstack/localstack:latest` or use the `docker-compose pull` if the image is set to `localstack/localstack:latest`. You can also specify a particular digest to make sure you are using the correct image, like this: `localstack/localstack:latest@sha256:f803cc657843c6c7acf2631d15600783c3593e496fba418415afc87680d9d5bc`.
41+
To use the latest LocalStack Docker images, you either run `docker pull localstack/localstack:latest` or use the `docker-compose pull` if the image is set to `localstack/localstack:latest`.
42+
You can also specify a particular digest to make sure you are using the correct image, like this: `localstack/localstack:latest@sha256:f803cc657843c6c7acf2631d15600783c3593e496fba418415afc87680d9d5bc`.
4143

4244
You can also use the our diagnose endpoint (`http://localhost:4566/_localstack/diagnose`) to get the specific image hashes and compare them with the current (latest) images on [Docker Hub](https://hub.docker.com/r/localstack/).
4345
The diagnose endpoint is only available if you run LocalStack with `DEBUG=1`.
4446

47+
### What do the tags of the LocalStack Docker images mean?
48+
49+
We do push a set of different image tags for the LocalStack Docker images.
50+
When using LocalStack, you can decide which tag you want to use.
51+
These tags have different semantics and will be updated on different occasions:
52+
- `latest` (default)
53+
- This is our default tag.
54+
It refers to the latest commit which has been fully tested using our extensive integration test suite.
55+
- This also entails changes that are part of major releases, which means that this tag can contain breaking changes.
56+
- This tag should be used if you want to stay up-to-date with the latest changes.
57+
- `stable`
58+
- This tag refers to the latest tagged release.
59+
It will be updated with every release of LocalStack.
60+
- This also entails major releases, which means that this tag can contain breaking changes.
61+
- This tag should be used if you want to stay up-to-date with releases, but don't necessarily need the latest and greatest changes right away.
62+
- `<major>` (e.g. `3`)
63+
- These tags can be used to refer to the latest release of a specific major release.
64+
It will be updated with every minor and patch release within this major release.
65+
- This tag should be used if you want to avoid any potential breaking changes.
66+
- `<major>.<minor>` (e.g. `3.0`)
67+
- These tags can be used to refer to the latest release of a specific minor release.
68+
It will be updated with every patch release within this minor release.
69+
- This tag can be used if you want to avoid any bigger changes, like new features, but still want to update to the latest bugfix release.
70+
- `<major>.<minor>.<patch>` (e.g. `3.0.2`)
71+
- These tags can be used if you want to use a very specific release.
72+
It will not be updated.
73+
- This tag can be used if you really want to avoid any changes to the image (not even minimal bug fixes).
74+
4575
### How can I access LocalStack from an alternative computer?
4676

47-
You can access LocalStack from an alternative computer, by exposing port `4566` to the public network interface (`0.0.0.0` instead of `127.0.0.1`) in your `docker-compose.yml` configuration. However, we do not recommend using this setup - for security reasons, as it exposes your local computer to potential attacks from the outside world.
77+
You can access LocalStack from an alternative computer, by exposing port `4566` to the public network interface (`0.0.0.0` instead of `127.0.0.1`) in your `docker-compose.yml` configuration.
78+
However, we do not recommend using this setup - for security reasons, as it exposes your local computer to potential attacks from the outside world.
4879

4980
### How to resolve Git Bash issues with LocalStack?
5081

5182
If you're using Git Bash with LocalStack, you might encounter some issues.
5283
This is due to the automatic conversion of POSIX paths to Windows paths when command-line options start with a slash.
53-
For instance, `"/usr/bin/bash.exe"` would be converted to `"C:\Program Files\Git\usr\bin\bash.exe"`.
54-
This conversion can cause problems when it's not needed, such as with `"--name /test/parameter/new"`.
84+
For instance, `"/usr/bin/bash.exe"` would be converted to `"C:\Program Files\Git\usr\bin\bash.exe"`.
85+
This conversion can cause problems when it's not needed, such as with `"--name /test/parameter/new"`.
5586
To prevent this, you can temporarily set the `MSYS_NO_PATHCONV` environment variable.
5687
Another workaround is to double the first slash in your command to prevent the POSIX-to-Windows path conversion.
5788

@@ -74,7 +105,8 @@ For additional known issues related to Git Bash, you can refer to the following
74105

75106
### How to fix LocalStack CLI (Python) UTF-8 encoding issue under Windows?
76107

77-
If you are using LocalStack CLI under Windows, you might run into encoding issues. To fix this, set the following environment variables:
108+
If you are using LocalStack CLI under Windows, you might run into encoding issues.
109+
To fix this, set the following environment variables:
78110
Set the system locale (language for non-Unicode programs) to UTF-8 to avoid Unicode errors.
79111

80112
Follow these steps:
@@ -89,7 +121,8 @@ If you would like to keep the system locale as it is, you can mitigate the issue
89121

90122
### How do I resolve connection issues with proxy blocking access to LocalStack's BigData image?
91123

92-
A company proxy can lead to connection issues. To allow access to the `localstack/bigdata` image, use the following Docker configuration in your `docker-compose.yml` file:
124+
A company proxy can lead to connection issues.
125+
To allow access to the `localstack/bigdata` image, use the following Docker configuration in your `docker-compose.yml` file:
93126

94127
```yaml
95128
...
@@ -101,7 +134,8 @@ environment:
101134

102135
### Why is it that LocalStack is unable to connect to internet?
103136

104-
You might be able to connect to the internet, but your Docker container can't connect. This can affect start of LocalStack.
137+
You might be able to connect to the internet, but your Docker container can't connect.
138+
This can affect start of LocalStack.
105139

106140
Please ensure that you are not using the `none` network driver when starting your docker container.
107141
More details about the default bridge network can be found on [official docker documentation](https://docs.docker.com/network/bridge).
@@ -129,7 +163,9 @@ Refer to our [network troubleshooting guide]({{< ref "references/network-trouble
129163

130164
### How to resolve the pull rate limit issue for LocalStack's Docker image?
131165

132-
If you receive `ERROR: toomanyrequests: Too Many Requests.` when pulling the LocalStack Docker image, you have reached your pull rate limit. You may increase the limit by [authenticating and upgrading](https://www.docker.com/increase-rate-limits). Set your DockerHub credentials:
166+
If you receive `ERROR: toomanyrequests: Too Many Requests.` when pulling the LocalStack Docker image, you have reached your pull rate limit.
167+
You may increase the limit by [authenticating and upgrading](https://www.docker.com/increase-rate-limits).
168+
Set your DockerHub credentials:
133169

134170
```bash
135171
(sudo) docker login --username=yourUsername
@@ -146,7 +182,8 @@ You can add in the volume `~/.docker/config.json:/config.json` where the `con
146182
...
147183
```
148184

149-
If you have an active AWS account, you can use the public AWS ECR image. You can use the following command to pull the image:
185+
If you have an active AWS account, you can use the public AWS ECR image.
186+
You can use the following command to pull the image:
150187

151188
{{< tabpane >}}
152189
{{< tab header="Community" lang="shell" >}}
@@ -211,17 +248,23 @@ The easiest way to check if LocalStack Pro or Enterprise is activated is to chec
211248
$ curl localhost:4566/_localstack/health | jq
212249
{{< / command >}}
213250

214-
If a Pro-only [service]({{< ref "aws" >}}) -- like [XRay]({{< ref "xray" >}}) -- is running, LocalStack Pro or Enterprise has started successfully. If your auth token is invalid, you will see an error message like this in the logs of LocalStack:
251+
If a Pro-only [service]({{< ref "aws" >}}) -- like [XRay]({{< ref "xray" >}}) -- is running, LocalStack Pro or Enterprise has started successfully.
252+
If your auth token is invalid, you will see an error message like this in the logs of LocalStack:
215253

216254
```bash
217255
license activation failed! Reason: ...
218256
```
219257

220-
If this error occurs, something is wrong with your auth token or license. Make sure your auth token is set correctly (check for typos!) and your license is valid. If the auth token still does not work, please [contact us](https://localstack.cloud/contact/).
258+
If this error occurs, something is wrong with your auth token or license.
259+
Make sure your auth token is set correctly (check for typos!) and your license is valid.
260+
If the auth token still does not work, please [contact us](https://localstack.cloud/contact/).
221261

222262
### How are CI credits in LocalStack calculated?
223263

224-
A CI key allows you to use LocalStack in your CI environment. Every activation of a CI key consumes one build credit. This means that with every build triggered through the LocalStack container you will consume one credit. To understand the CI pricing across our product tiers, follow up with our [LocalStack in CI]({{<ref "user-guide/ci">}}) documentation.
264+
A CI key allows you to use LocalStack in your CI environment.
265+
Every activation of a CI key consumes one build credit.
266+
This means that with every build triggered through the LocalStack container you will consume one credit.
267+
To understand the CI pricing across our product tiers, follow up with our [LocalStack in CI]({{<ref "user-guide/ci">}}) documentation.
225268

226269
### What should I do if I cannot connect to LocalStack API?
227270

@@ -233,7 +276,8 @@ WARNING:localstack_ext.bootstrap.licensing: Error activating API key "abc..."(10
233276
ConnectionRefusedError: [Errno 111] Connection refused
234277
```
235278

236-
LocalStack cannot contact our API to perform the license activation. Confirm with your network administrator that no policies block the connection to our backend.
279+
LocalStack cannot contact our API to perform the license activation.
280+
Confirm with your network administrator that no policies block the connection to our backend.
237281

238282
### What should I do if I cannot resolve `api.localstack.cloud`?
239283

@@ -253,20 +297,28 @@ $ dig api.localstack.cloud
253297

254298
If the result has some other status than `status: NOERROR,` your machine cannot resolve this domain.
255299

256-
Some corporate DNS servers might filter requests to certain domains. Contact your network administrator to safelist` localstack.cloud` domains.
300+
Some corporate DNS servers might filter requests to certain domains.
301+
Contact your network administrator to safelist` localstack.cloud` domains.
257302

258303
### How does LocalStack Pro handle security patches and bug fixes?
259304

260-
We take security seriously and respond to any emergency vulnerabilities as soon as possible. Our cloud provider (AWS) handles most of the infrastructure maintenance for us. We also use Infrastructure-as-Code scripts to ensure that our infrastructure configuration is consistent and recoverable in case of a disaster.
305+
We take security seriously and respond to any emergency vulnerabilities as soon as possible.
306+
Our cloud provider (AWS) handles most of the infrastructure maintenance for us.
307+
We also use Infrastructure-as-Code scripts to ensure that our infrastructure configuration is consistent and recoverable in case of a disaster.
261308

262309
### How does LocalStack ensure the security of its containers and images?
263310

264-
Our software assets are regularly checked for vulnerabilities, such as code issues and outdated dependencies. We use Dependabot to scan our GitHub repositories, and Trivy as well as Snyk (among other security tools) to scan our Docker images.
311+
Our software assets are regularly checked for vulnerabilities, such as code issues and outdated dependencies.
312+
We use Dependabot to scan our GitHub repositories, and Trivy as well as Snyk (among other security tools) to scan our Docker images.
265313

266314
### Do you have any penetration test reports or SOC2 reports that demonstrate your security compliance?
267315

268-
We conduct regular penetration tests and audits to ensure our services are secure and compliant. If you want to access our security documentation and test reports, please contact us at info@localstack.cloud, and we will be happy to share them with you.
316+
We conduct regular penetration tests and audits to ensure our services are secure and compliant.
317+
If you want to access our security documentation and test reports, please contact us at info@localstack.cloud, and we will be happy to share them with you.
269318

270319
### Does LocalStack provide offline capabilities?
271320

272-
LocalStack Community and Pro/Team provide limited offline capabilities. To use a fully-fledged offline mode, you may use LocalStack Enterprise, which can be used in air-gapped environments. The regular LocalStack Docker images may need to download additional dependencies for specific services (e.g., Elasticsearch, Big Data services) at runtime, while the offline image bakes all dependencies into the image, along with any other configuration that you might need. For more details, please take a look at our [Enterprise offering](https://localstack.cloud/pricing).
321+
LocalStack Community and Pro/Team provide limited offline capabilities.
322+
To use a fully-fledged offline mode, you may use LocalStack Enterprise, which can be used in air-gapped environments.
323+
The regular LocalStack Docker images may need to download additional dependencies for specific services (e.g., Elasticsearch, Big Data services) at runtime, while the offline image bakes all dependencies into the image, along with any other configuration that you might need.
324+
For more details, please take a look at our [Enterprise offering](https://localstack.cloud/pricing).

0 commit comments

Comments
 (0)