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/capabilities/cloud-sandbox/app-preview.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
@@ -110,4 +110,4 @@ preview-cmd: |
110
110
111
111
## Examples
112
112
113
-
- [Creating ephemeral application previews with LocalStack and GitHub Actions](/aws/tutorials/ephemeral-application-previews/) and the [example repository](https://github.com/localstack-samples/sample-notes-app-dynamodb-lambda-apigateway)
113
+
- [Creating ephemeral application previews with LocalStack and GitHub Actions]() and the [example repository](https://github.com/localstack-samples/sample-notes-app-dynamodb-lambda-apigateway)
Copy file name to clipboardExpand all lines: src/content/docs/aws/capabilities/config/configuration.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ Options that affect the core LocalStack system.
31
31
|`GATEWAY_LISTEN`|`0.0.0.0:4566` (default in Docker mode) `127.0.0.1:4566` (default in host mode) | Configures the bind addresses of LocalStack. It has the form `<ip address>:<port>(,<ip address>:<port>)*`. LocalStack Pro adds port `443`. |
32
32
|`LOCALSTACK_HOST`|`localhost.localstack.cloud:4566` (default) | This is interpolated into URLs and addresses that are returned by LocalStack. It has the form `<hostname>:<port>`. |
33
33
|`USE_SSL`|`0` (default) | Whether to return URLs using HTTP (`0`) or HTTPS (`1`). Changed with 3.0.0. In earlier versions this was toggling SSL support on or off. |
34
-
|`PERSISTENCE`|`0` (default) | Enable persistence. See [Persistence Mechanism](/aws/capabilities/state-management/persistence) and [Filesystem Layout](/aws/capabilities/config/filesystem-layout). |
34
+
|`PERSISTENCE`|`0` (default) | Enable persistence. See [Persistence Mechanism](/aws/capabilities/state-management/persistence) and [Filesystem Layout](/aws/capabilities/config/filesystem). |
35
35
|`MAIN_CONTAINER_NAME`|`localstack-main` (default) | Specify the main docker container name |
36
36
|`LS_LOG`|`trace`, `trace-internal`, `debug`, `info`, `warn`, `error`, `warning`| Specify the log level. Currently overrides the `DEBUG` configuration. `trace` for detailed request/response, `trace-internal` for internal calls, too. |
37
37
|`EXTERNAL_SERVICE_PORTS_START`|`4510` (default) | Start of the [External Service Port Range](/aws/capabilities/networking/external-port-range) (inclusive). |
@@ -47,7 +47,7 @@ These options are applicable when using the CLI to start LocalStack.
47
47
48
48
| Variable | Example Values | Description |
49
49
| - | - | - |
50
-
|`LOCALSTACK_VOLUME_DIR`|`~/.cache/localstack/volume` (on Linux) | The location on the host of the LocalStack volume directory mount. See [Filesystem Layout](/aws/capabilities/config/filesystem-layout#using-the-cli)|
50
+
|`LOCALSTACK_VOLUME_DIR`|`~/.cache/localstack/volume` (on Linux) | The location on the host of the LocalStack volume directory mount. See [Filesystem Layout](/aws/capabilities/config/filesystem#using-the-cli)|
51
51
|`CONFIG_PROFILE`|| The configuration profile to load. See [Profiles](#profiles)|
52
52
|`CONFIG_DIR`|`~/.localstack`| The path where LocalStack can find configuration profiles and other CLI-specific configuration |
53
53
@@ -226,7 +226,7 @@ Also see [OpenSearch configuration variables](#opensearch) which are used to man
226
226
| Variable | Example Values | Description |
227
227
| - | - | - |
228
228
|`ENFORCE_IAM` (pro) |`0` (default)\|`1`| Enable IAM policy evaluation and enforcement. If this is disabled (the default), IAM policies will have no effect to your requests. |
229
-
|`IAM_SOFT_MODE` (pro) |`0` (default)\|`1`| Enable IAM soft mode. This leads to policy evaluation without actually denying access. Needs `ENFORCE_IAM` enabled as well. For more information, see [Identity and Access Management](/aws/servicesiam).|
229
+
|`IAM_SOFT_MODE` (pro) |`0` (default)\|`1`| Enable IAM soft mode. This leads to policy evaluation without actually denying access. Needs `ENFORCE_IAM` enabled as well. For more information, see [Identity and Access Management](/aws/services/iam).|
230
230
231
231
### Kinesis
232
232
@@ -252,7 +252,7 @@ Please consult the [migration guide](/aws/services/lambda#migrating-to-lambda-v2
252
252
|`BUCKET_MARKER_LOCAL`|`hot-reload` (default) | Magic S3 bucket name for [Hot Reloading](/aws/tooling/lambda-tools/hot-reloading). The S3Key points to the source code on the local file system. |
253
253
|`HOSTNAME_FROM_LAMBDA`|`localstack`| Endpoint host under which APIs are accessible from Lambda containers (optional). This can be useful in docker-compose stacks to use the local container hostname if neither IP address nor container name of the main container are available (e.g., in CI). Often used in combination with `LAMBDA_DOCKER_NETWORK`.|
254
254
|`LAMBDA_DISABLE_AWS_ENDPOINT_URL`|`0` (default) \|`1`| Whether to disable injecting the environment variable `AWS_ENDPOINT_URL`, which automatically configures [supported AWS SDKs](https://docs.aws.amazon.com/sdkref/latest/guide/feature-ss-endpoints.html). |
255
-
|`LAMBDA_DISABLE_JAVA_SDK_V2_CERTIFICATE_VALIDATION`|`1` (default) | Whether to disable the certificate name validation for [AWS Java SDK v2](https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/home.html) calls when using [transparent endpoint injection](/aws/tooling/transparent-endpoint-injection).|
255
+
|`LAMBDA_DISABLE_JAVA_SDK_V2_CERTIFICATE_VALIDATION`|`1` (default) | Whether to disable the certificate name validation for [AWS Java SDK v2](https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/home.html) calls when using [transparent endpoint injection](/aws/capabilities/networking/transparent-endpoint-injection).|
256
256
|`LAMBDA_DOCKER_DNS`|`""` (default) | Optional custom DNS server for the container running your Lambda function. Overwrites the default LocalStack [DNS Server](/aws/tooling/dns-server). Hence, resolving `localhost.localstack.cloud` requires additional configuration. |
257
257
|`LAMBDA_DOCKER_FLAGS`|`-e KEY=VALUE`, `-v host:container`, `-p host:container`, `--add-host domain:ip`| Additional flags passed to Docker `run`\|`create` commands. Supports environment variables (also with `--env-file`, but the file has to be mounted into the LocalStack container), ports, volume mounts, extra hosts, networks, DNS servers, labels, ulimits, user, platform, and privileged mode. The `--env-file` argument for Docker `run` and Docker Compose have different feature sets. To provide both, we support the `--env-file` for environment files with the docker run syntax, while `--compose-env-file` supports the full docker compose features, like placeholders with `${}`, replacing quotes, etc. |
258
258
|`LAMBDA_DOCKER_NETWORK`|`bridge` (Docker default) |[Docker network driver](https://docs.docker.com/network/) for the Lambda and ECS containers. Needs to be set to the network the LocalStack container is connected to. Limitation: `host` mode currently not supported. |
@@ -310,7 +310,7 @@ Please consult the [migration guide](/aws/services/lambda#migrating-to-lambda-v2
310
310
| - | - | - |
311
311
|`OPENSEARCH_CUSTOM_BACKEND`|`http://opensearch:9200`| URL to a custom OpenSearch backend cluster. If this is set to a valid URL, then LocalStack will not create OpenSearch cluster instances, but instead forward all domains to the given backend (see [Custom Opensearch Backends](/aws/services/opensearch#custom-opensearch-backends). |
312
312
|`OPENSEARCH_MULTI_CLUSTER`|`1`\|`0`| When activated, LocalStack will spawn one OpenSearch cluster per domain. Otherwise all domains will share a single cluster instance. This is ignored if `OPENSEARCH_CUSTOM_BACKEND` is set. |
313
-
|`OPENSEARCH_ENDPOINT_STRATEGY`|`path`\|`domain`\|`port`| Governs how domain endpoints are created to access a cluster (see [Opensearch Endpoints](/aws/services/opensearch#endpoints)). |
313
+
|`OPENSEARCH_ENDPOINT_STRATEGY`|`path`\|`domain`\|`port`| Governs how domain endpoints are created to access a cluster (see [Opensearch Endpoints](/aws/services/opensearch#domain-endpoints)). |
314
314
|`SKIP_INFRA_DOWNLOADS`|`1`\|`0` (default) |**Deprecated since 1.3.0** Whether to skip downloading additional infrastructure components (e.g., specific Elasticsearch versions) |
315
315
|`IGNORE_OS_DOWNLOAD_ERRORS`|`0`\|`1`| Whether to ignore errors (e.g., network/SSL) when downloading OpenSearch plugins |
316
316
@@ -345,8 +345,8 @@ Please consult the [migration guide](/aws/services/lambda#migrating-to-lambda-v2
345
345
| - | - | - |
346
346
|`SQS_DELAY_PURGE_RETRY`|`0` (default) | Used to toggle PurgeQueueInProgress errors when making more than one PurgeQueue call within 60 seconds. |
347
347
|`SQS_DELAY_RECENTLY_DELETED`|`0` (default) | Used to toggle QueueDeletedRecently errors when re-creating a queue within 60 seconds of deleting it. |
348
-
|`SQS_ENABLE_MESSAGE_RETENTION_PERIOD`|`0` (default) \|`1`| Used to toggle the MessageRetentionPeriod feature (see [Enabling `MessageRetentionPeriod`](/aws/sqs/#enabling-messageretentionperiod)|
349
-
|`SQS_ENDPOINT_STRATEGY`|`standard` (default) \|`domain`\|`path`\|`off`| Configures the format of Queue URLs (see [SQS Queue URLs](/aws/sqs/#queue-urls)|
348
+
|`SQS_ENABLE_MESSAGE_RETENTION_PERIOD`|`0` (default) \|`1`| Used to toggle the MessageRetentionPeriod feature (see [Enabling `MessageRetentionPeriod`](/aws/services/sqs/#enabling-messageretentionperiod)|
349
+
|`SQS_ENDPOINT_STRATEGY`|`standard` (default) \|`domain`\|`path`\|`off`| Configures the format of Queue URLs (see [SQS Queue URLs](/aws/services/sqs/#queue-urls)|
350
350
|`SQS_DISABLE_CLOUDWATCH_METRICS`|`0` (default) | Disables the CloudWatch Metrics for SQS when set to `1`|
351
351
|`SQS_CLOUDWATCH_METRICS_REPORT_INTERVAL`|`60` (default) | Configures the report interval (in seconds) for `Approximate*` metrics that are sent to CloudWatch periodically. Sending will be disabled if `SQS_DISABLE_CLOUDWATCH_METRICS=1`|
352
352
@@ -449,7 +449,7 @@ To learn more about these configuration options, see [DNS Server](/aws/tooling/d
449
449
450
450
| Variable | Example Values | Description |
451
451
| - | - | - |
452
-
| `DISABLE_TRANSPARENT_ENDPOINT_INJECTION` | `0` (default in Pro) \|`1` | Whether to disable DNS resolution of AWS hostnames to the LocalStack container. Pro feature. (see [Transparent Endpoint Injection](/aws/tooling/transparent-endpoint-injection))
452
+
| `DISABLE_TRANSPARENT_ENDPOINT_INJECTION` | `0` (default in Pro) \|`1` | Whether to disable DNS resolution of AWS hostnames to the LocalStack container. Pro feature. (see [Transparent Endpoint Injection](/aws/capabilities/networking/transparent-endpoint-injection))
453
453
454
454
## LocalStack Pro
455
455
@@ -515,7 +515,7 @@ These configurations have already been removed and **won't have any effect** on
515
515
| `DISABLE_TERM_HANDLER` | 2.0.0 | `""` (default) \|`1` | Whether to disable signal passing to LocalStack when running in docker. Enabling this will prevent an orderly shutdown when running inside LS in docker. Setting this to anything else than an empty string will disable it.
516
516
|`HOST_TMP_FOLDER`| 2.0.0 |`/some/path`| Temporary folder on the host that gets mounted as `$TMPDIR/localstack` into the LocalStack container. Required only for Lambda volume mounts when using `LAMBDA_REMOTE_DOCKER=false.`|
517
517
|`INIT_SCRIPTS_PATH`| 2.0.0 |`/some/path`| Before 1.0, this was used to configure the path to the initializing files with extensions `.sh` that were found in `/docker-entrypoint-initaws.d`. This has been replaced by the [init-hook system](/aws/capabilities/config/initialization-hooks/). |
518
-
|`LEGACY_DIRECTORIES`| 2.0.0 |`0` (default) | Use legacy method of managing internal filesystem layout. See [Filesystem Layout](/aws/capabilities/config/filesystem-layout). |
518
+
|`LEGACY_DIRECTORIES`| 2.0.0 |`0` (default) | Use legacy method of managing internal filesystem layout. See [Filesystem Layout](/aws/capabilities/config/filesystem). |
519
519
|`LEGACY_INIT_DIR`| 2.0.0 |`1`\|`0`(default) | Used with `INIT_SCRIPTS_PATH`. This has been replaced by the [init-hook system](/aws/capabilities/config/initialization-hooks). |
For a more complex demo project, on how to use Terraform init hooks for your testing environments, you can check out [this example](/aws/tutorials/using-terraform-with-testcontainers-and-localstack/) in the Tutorials section.
233
+
For a more complex demo project, on how to use Terraform init hooks for your testing environments, you can check out [this example]() in the Tutorials section.
Copy file name to clipboardExpand all lines: src/content/docs/aws/capabilities/networking/external-port-range.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
@@ -18,13 +18,13 @@ This documentation discusses two approaches to access these external services wi
18
18
LocalStack offers a proxy functionality to access external services indirectly.
19
19
In this approach, LocalStack assigns local domains to the external services based on the individual service's configuration.
20
20
21
-
For instance, if OpenSearch is configured to use the [`OPENSEARCH_ENDPOINT_STRATEGY=domain`](/aws/services/opensearch#endpoints) setting, a cluster can be reached using the domain name `<domain-name>.<region>.<engine-type>.localhost.localstack.cloud`.
21
+
For instance, if OpenSearch is configured to use the [`OPENSEARCH_ENDPOINT_STRATEGY=domain`](/aws/services/opensearch#domain-endpoints) setting, a cluster can be reached using the domain name `<domain-name>.<region>.<engine-type>.localhost.localstack.cloud`.
22
22
Incoming messages to these domains are relayed to servers running on ports that do not require external accessibility.
23
23
24
24
## Direct Access with External Service Port Range
25
25
26
26
An alternative approach to accessing external services is by utilizing the _external service port range_.
27
-
This method, applicable to services like OpenSearch, is activated using the [`OPENSEARCH_ENDPOINT_STRATEGY=port`](/aws/services/opensearch#endpoints) configuration.
27
+
This method, applicable to services like OpenSearch, is activated using the [`OPENSEARCH_ENDPOINT_STRATEGY=port`](/aws/services/opensearch#domain-endpoints) configuration.
28
28
The external service port range is pre-defined and set to `4510-4559` by default.
29
29
30
30
When a LocalStack service starts an external service, it automatically selects an available port from within the specified range.
0 commit comments