Installation
Basic installation guide to get started with LocalStack on your local machine.
LocalStack CLI
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 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.
You can install the LocalStack CLI using Brew directly from our official LocalStack tap:
Please make sure to install the following tools on your machine before moving ahead:
$ brew install localstack/tap/localstack-cliAlternative: Binary Download
Alternatively, you can download the respective binary for your architecture directly:
or use this curl command:
$ curl -Lo localstack-cli-2.2.0-darwin-amd64-onefile.tar.gz \
- https://github.com/localstack/localstack-cli/releases/download/v2.2.0/localstack-cli-2.2.0-darwin-amd64-onefile.tar.gzThen extract the LocalStack CLI from the terminal:
$ sudo tar xvzf localstack-cli-2.2.0-darwin-*-onefile.tar.gz -C /usr/local/binAlternative: Python
+For alternative methods of managing the LocalStack container, see our alternative installation instructions.You can install the LocalStack CLI using Brew directly from our official LocalStack tap:
Please make sure to install the following tools on your machine before moving ahead:
$ brew install localstack/tap/localstack-cliAlternative: Binary Download
Alternatively, you can download the respective binary for your architecture directly:
or use this curl command:
$ curl -Lo localstack-cli-2.3.0-darwin-amd64-onefile.tar.gz \
+ https://github.com/localstack/localstack-cli/releases/download/v2.3.0/localstack-cli-2.3.0-darwin-amd64-onefile.tar.gzThen extract the LocalStack CLI from the terminal:
$ sudo tar xvzf localstack-cli-2.3.0-darwin-*-onefile.tar.gz -C /usr/local/binAlternative: Python
You can also install the LocalStack CLI directly in your Python environment.Please make sure to install the following tools on your machine before moving ahead:
Afterwards you can install the LocalStack CLI in your Python environment with:
$ python3 -m pip install --upgrade localstackImportant
Do not usesudo or the root user - LocalStack should be installed and started entirely under a local non-root user.
-If you have problems with permissions in MacOS X Sierra, install with python3 -m pip install --user localstack.You can download the respective binary for your architecture directly:
or use this curl command:
For x86-64:
$ curl -Lo localstack-cli-2.2.0-linux-amd64-onefile.tar.gz \
- https://github.com/localstack/localstack-cli/releases/download/v2.2.0/localstack-cli-2.2.0-linux-amd64-onefile.tar.gzOr ARM64:
$ curl -Lo localstack-cli-2.2.0-linux-arm64-onefile.tar.gz \
- https://github.com/localstack/localstack-cli/releases/download/v2.2.0/localstack-cli-2.2.0-linux-arm64-onefile.tar.gzThen extract the LocalStack CLI from the terminal:
$ sudo tar xvzf localstack-cli-2.2.0-linux-*-onefile.tar.gz -C /usr/local/binAlternative: Homebrew on Linux
+If you have problems with permissions in MacOS X Sierra, install withpython3 -m pip install --user localstack.You can download the respective binary for your architecture directly:
or use this curl command:
For x86-64:
$ curl -Lo localstack-cli-2.3.0-linux-amd64-onefile.tar.gz \
+ https://github.com/localstack/localstack-cli/releases/download/v2.3.0/localstack-cli-2.3.0-linux-amd64-onefile.tar.gzOr ARM64:
$ curl -Lo localstack-cli-2.3.0-linux-arm64-onefile.tar.gz \
+ https://github.com/localstack/localstack-cli/releases/download/v2.3.0/localstack-cli-2.3.0-linux-arm64-onefile.tar.gzThen extract the LocalStack CLI from the terminal:
$ sudo tar xvzf localstack-cli-2.3.0-linux-*-onefile.tar.gz -C /usr/local/binAlternative: Homebrew on Linux
Alternatively, if you are using Homebrew for Linux, you can install the LocalStack CLI directly from our official LocalStack tap:$ brew install localstack/tap/localstack-cliAlternative: Python
You can also install the LocalStack CLI directly in your PYthon environment.Please make sure to install the following tools on your machine before moving ahead:
Afterwards you can install the LocalStack CLI in your Python environment with:
$ python3 -m pip install --upgrade localstackImportant
Do not usesudo or the root user - LocalStack should be installed and started entirely under a local non-root user.You can download the respective binary for your architecture directly:
-
Then extract the archive and execute the binary using Powershell. +
Then extract the archive and execute the binary using Powershell.
Please make sure to install the following tools on your machine before moving ahead:
Then extract the archive and execute the binary using Powershell. +
Then extract the archive and execute the binary using Powershell.
Alternative: Python
You can also install the LocalStack CLI directly in your Python environment.Please make sure to install the following tools on your machine before moving ahead:
Afterwards you can install the LocalStack CLI in your Python environment with:
$ python3 -m pip install --upgrade localstackImportant
Do not usesudo or the root user - LocalStack should be installed and started entirely under a local non-root user.If you cannot use one of our prebuilt binary releases of LocalStack, you can install the LocalStack CLI in a Python environment.
Please make sure to install the following tools on your machine before moving ahead:
Please make sure to install the following tools on your machine before moving ahead:
Afterwards you can install the LocalStack CLI in your Python environment with:
$ python3 -m pip install --upgrade localstackNote
To download a specific version of LocalStack, check out our release page and download it in the following manner:
$ python3 -m pip install localstack==<version>Here <version> depicts the particular LocalStack version that you would like to download and use.
Important
Do not usesudo or the root user - LocalStack should be installed and started entirely under a local non-root user.To verify that the LocalStack CLI was installed correctly, you can check the version in your terminal:
$ localstack --version
-2.2.0You are all set! +2.3.0
You are all set! To use all of LocalStack’s features we recommend to get a LocalStack account and set up your api key. Afterwards, check out our Quickstart guide to start your local cloud!
Alternatives
Besides using the CLI, there are other ways of starting and managing your LocalStack instance:
LocalStack Cockpit
Get a desktop experience and work with your local LocalStack instance via the UI.LocalStack Docker Extension
Use the LocalStack extension for Docker Desktop to work with your LocalStack instance.Docker-Compose
Usedocker-composeto configure and start your LocalStack Docker container.Docker
Use thedockerCLI to manually start the LocalStack Docker container.Helm
Usehelmto create a LocalStack deployment in a Kubernetes cluster.
LocalStack runs inside a Docker container, and the above options are different ways to start and manage the LocalStack Docker container. For a comprehensive overview of the LocalStack images, check out our Docker images documentation.
LocalStack Cockpit
Download our desktop client at localstack.cloud/products/cockpit. diff --git a/references/configuration/index.html b/references/configuration/index.html index 7cd7fdcec8..4f52200ffd 100644 --- a/references/configuration/index.html +++ b/references/configuration/index.html @@ -1,7 +1,7 @@
Table of Contents
Configuration
Overview of configuration options in LocalStack
19 minute read
LocalStack exposes various configuration options to control its behaviour.
These options can be passed to LocalStack as environment variables like so:
$ DEBUG=1 localstack startYou can also use Profiles.
Core
Options that affect the core LocalStack system.
| Variable | Example Values | Description |
|---|---|---|
DEBUG | 0 (default) |1 | Flag to increase log level and print more verbose logs (useful for troubleshooting issues) |
IMAGE_NAME | localstack/localstack (default), localstack/localstack:0.11.0 | Specific name and tag of LocalStack Docker image to use. |
GATEWAY_LISTEN | 127.0.0.1:4566 (default in host mode), 0.0.0.0:4566 (default in Docker mode) | Configures the bind addresses of LocalStack. It has the form <ip address>:<port>(,<ip address>:<port>)*. |
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>. |
LEGACY_DIRECTORIES | 0 (default) | Use legacy method of managing internal filesystem layout. See Filesystem Layout. |
PERSISTENCE | 0 (default) | Enable persistence. See Persistence Mechanism and Filesystem Layout. |
PERSIST_ALL | true (default) | Whether to persist all resources (including user code like Lambda functions), or only “light-weight” resources (e.g., SQS queues, or Cognito users). Can be set to false to reduce storage size of DATA_DIR folders or Cloud Pods. |
MAIN_CONTAINER_NAME | localstack_main (default) | Specify the main docker container name |
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. |
EXTERNAL_SERVICE_PORTS_START | 4510 (default) | Start of the External Service Port Range (inclusive). |
EXTERNAL_SERVICE_PORTS_END | 4560 (default) | End of the External Service Port Range (exclusive). |
EAGER_SERVICE_LOADING | 0 (default) | Boolean that toggles lazy loading of services. If eager loading is enabled, services are started at LocalStack startup rather than their first use. Eager loading significantly increases LocalStack startup time. |
ALLOW_NONSTANDARD_REGIONS | 0 (default) | Allows the use of non-standard AWS regions. By default, LocalStack only accepts standard AWS regions. |
PARITY_AWS_ACCESS_KEY_ID | 0 (default) | Enables the use production-like access key IDs. By default, LocalStack issues keys with LSIA... and LKIA... prefix, and will reject keys that start with ASIA... or AKIA.... |
CLI
These options are applicable when using the CLI to start LocalStack.
| Variable | Example Values | Description |
|---|---|---|
LOCALSTACK_VOLUME_DIR | ~/.cache/localstack/volume (on Linux) | The location on the host of the LocalStack volume directory mount. See Filesystem Layout |
CONFIG_PROFILE | The configuration profile to load. See Profiles | |
CONFIG_DIR | ~/.localstack | The path where LocalStack can find configuration profiles and other CLI-specific configuration |
Docker
Options to configure how LocalStack interacts with Docker.
| Variable | Example Values | Description |
|---|---|---|
DOCKER_FLAGS | Allows to pass custom flags (e.g., volume mounts) to “docker run” when running LocalStack in Docker. | |
DOCKER_SOCK | /var/run/docker.sock | Path to local Docker UNIX domain socket |
DOCKER_BRIDGE_IP | 172.17.0.1 | IP of the docker bridge used to enable access between containers |
LEGACY_DOCKER_CLIENT | 0|1 | Whether LocalStack should use the command-line Docker client and subprocess execution to run Docker commands, rather than the Docker SDK. |
DOCKER_CMD | docker (default), sudo docker | Shell command used to run Docker containers (only used in combination with LEGACY_DOCKER_CLIENT) |
FORCE_NONINTERACTIVE | When running with Docker, disables the --interactive and --tty flags. Useful when running headless. |
Local AWS Services
This section covers configuration options that are specific to certain AWS services.
AppSync
| Variable | Example Values | Description |
|---|---|---|
GRAPHQL_ENDPOINT_STRATEGY | legacy|domain|path | Governs how AppSync endpoints are created to access a GraphQL API (see AppSync Endpoints) |
Batch
| Variable | Example Values | Description |
|---|---|---|
BATCH_DOCKER_FLAGS | -e TEST_ENV=1337 | Additional flags provided to the batch container. Same restrictions as LAMBDA_DOCKER_FLAGS. |
BigData (EMR, Athena, Glue)
| Variable | Example Values | Description |
|---|---|---|
BIGDATA_DOCKER_NETWORK | Network the bigdata should be connected to. The LocalStack container has to be connected to that network as well. Per default, the bigdata container will be connected to a network LocalStack is also connected to. | |
BIGDATA_DOCKER_FLAGS | Additional flags for the bigdata container. Same restrictions as LAMBDA_DOCKER_FLAGS. |
DynamoDB
| Variable | Example Values | Description |
|---|---|---|
DYNAMODB_ERROR_PROBABILITY | Decimal value between 0.0(default) and 1.0 | Randomly inject ProvisionedThroughputExceededException errors into DynamoDB API responses. |
DYNAMODB_HEAP_SIZE | 256m (default), 1G | Sets the JAVA EE maximum memory size for DynamoDB; full table scans require more memory |
DYNAMODB_SHARE_DB | 0|1 | When activated, DynamodDB will use a single database instead of separate databases for each credential and region. |
DYNAMODB_IN_MEMORY | 0 (default) |1 | When activated, DynamodDB will start in in-memory mode, which can have a faster throughput. If you use this options, both persistence and cloud pods will not work for DynamoDB |
DYNAMODB_OPTIMIZE_DB_BEFORE_STARTUP | 0|1 | Optimize the database tables in the store before starting |
DYNAMODB_DELAY_TRANSIENT_STATUSES | 0|1 | When activated, DynamoDB will introduce artificial delays in resource creation to simulate the actual cloud service more closely. Currently works only for CREATING and DELETING online index statuses. |
DYNAMODB_CORS | * | Enable CORS support for specific allow-list list the domains separated by , use * for public access (default is *) |
ECS
| Variable | Example Values | Description |
|---|---|---|
ECS_REMOVE_CONTAINERS | 0|1 (default) | Remove Docker containers associated with ECS tasks after execution. Disabling this and dumping container logs might help with troubleshooting failing ECS tasks. |
ECS_DOCKER_FLAGS | --privileged, --dns 1.2.3.4 | Additional flags passed to Docker when creating ECS task containers. Same restrictions as LAMBDA_DOCKER_FLAGS. |
EC2
| Variable | Example Values | Description |
|---|---|---|
EC2_DOCKER_FLAGS | --privileged | Additional flags passed to Docker when launching containerized instances. Same restrictions as LAMBDA_DOCKER_FLAGS. |
EC2_DOWNLOAD_DEFAULT_IMAGES | 0|1 (default) | At startup, LocalStack Pro downloads latest Ubuntu images from Docker Hub for use as AMIs. This can be disabled for security reasons. |
EC2_MOUNT_BLOCK_DEVICES | 1|0 (default) | Whether to create and mount user-specified EBS block devices into EC2 container instances. |
EC2_EBS_MAX_VOLUME_SIZE | 1000 (default) | Maximum size (in MBs) of user-specified EBS block devices mounted into EC2 container instances. |
EKS
| Variable | Example Values | Description |
|---|---|---|
EKS_LOADBALANCER_PORT | 8081 (default) | Local port on which the Kubernetes load balancer is exposed on the host. |
EKS_K3S_IMAGE_TAG | v1.22.6-k3s1 (default) | Custom tag of the k8s/rancher image used to spin up Kubernetes clusters locally. |
Elasticsearch
Note
The OpenSearch configuration variables are used to manage both OpenSearch and ElasticSearch clusters. See here.IAM
| Variable | Example Values | Description |
|---|---|---|
ENFORCE_IAM | 0 (default)|1 | Enable IAM policy evaluation and enforcement. If this is disabled (the default), IAM policies will have no effect to your requests. |
IAM_SOFT_MODE | 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. |
Kinesis
| Variable | Example Values | Description |
|---|---|---|
KINESIS_ERROR_PROBABILITY | Decimal value between 0.0(default) and 1.0 | Randomly inject ProvisionedThroughputExceededException errors into Kinesis API responses. |
KINESIS_SHARD_LIMIT | 100 (default), Infinity (to disable) | Integer value , causing the Kinesis API to start throwing exceptions to mimic the default shard limit. |
KINESIS_ON_DEMAND_STREAM_COUNT_LIMIT | 10 (default), Infinity (to disable) | Integer value , causing the Kinesis API to start throwing exceptions to mimic the default on demand stream count limit. |
KINESIS_LATENCY | 500 (default), 0 (to disable) | Integer value of milliseconds, causing the Kinesis API to delay returning a response in order to mimic latency from a live AWS call. |
KINESIS_INITIALIZE_STREAMS | "my-first-stream:1,my-other-stream:2:us-west-2,my-last-stream:1" | A comma-delimited string of stream names, its corresponding shard count and an optional region to initialize during startup. If the region is not provided, the default region is used. Only works with the kinesis-mock KINESIS_PROVIDER. |
Lambda
Note
New Lambda implementation active since LocalStackĀ 2.0 (Dockerlatest since 2023-03-23).
-Please consult the page Lambda providers for more information.| Variable | Example Values | Description |
|---|---|---|
BUCKET_MARKER_LOCAL | hot-reload (default) | Magic S3 bucket name for Hot Reloading. The S3Key points to the source code on the local file system. |
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, ports, volume mounts, extra hosts, networks, DNS servers, labels, ulimits, user, platform, and privileged mode. |
LAMBDA_DOCKER_NETWORK | bridge (Docker default) | Docker network driver 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. |
LAMBDA_DOWNLOAD_AWS_LAYERS | 1 (default, pro) | Whether to download public Lambda layers from AWS through a LocalStack proxy when creating or updating functions. |
LAMBDA_IGNORE_ARCHITECTURE | 0 (default) | Whether to ignore the AWS architectures (x86_64 or arm64) configured for the lambda function. Set to 1 to run cross-platform compatible lambda functions natively (i.e., Docker selects architecture). |
LAMBDA_K8S_IMAGE_PREFIX | amazon/aws-lambda- (default, pro) | Prefix for images that will be used to execute Lambda functions in Kubernetes. |
LAMBDA_KEEPALIVE_MS | 600000 (default 10min) | Time in milliseconds until lambda shuts down the execution environment after the last invocation has been processed. Set to 0 to immediately shut down the execution environment after an invocation. |
LAMBDA_LIMITS_CONCURRENT_EXECUTIONS | 1000 (default) | The maximum number of events that functions can process simultaneously in the current Region. See AWS service quotas |
LAMBDA_REMOVE_CONTAINERS | 1 (default) | Whether to remove any Lambda Docker containers. |
LAMBDA_RUNTIME_ENVIRONMENT_TIMEOUT | 10 (default) | How many seconds Lambda will wait for the runtime environment to start up. |
LAMBDA_RUNTIME_EXECUTOR | docker (default) | Where Lambdas will be executed. |
kubernetes (pro) | Execute lambdas in a Kubernetes cluster. | |
LAMBDA_RUNTIME_IMAGE_MAPPING | base images for Lambda (default) | Customize the Docker image of Lambda runtimes, either by: a) pattern with <runtime> placeholder, e.g. custom-repo/lambda-<runtime>:2022b) json dict mapping the <runtime> to an image, e.g. {"python3.9": "custom-repo/lambda-py:thon3.9"} |
LAMBDA_SYNCHRONOUS_CREATE | 0 (default) | Set to 1 to create lambda functions synchronously (not recommended). |
LAMBDA_TRUNCATE_STDOUT | 2000 (default) | Allows increasing the default char limit for truncation of lambda log lines when printed in the console. This does not affect the logs processing in CloudWatch. |
PROVIDER_OVERRIDE_LAMBDA | v2 (default) | Currently supported implementation of our local Lambda service active since LocalStackĀ 2.0 (Docker latest since 2023-03-23). |
legacy (deprecated) | Use the old lambda provider (not recommended). See Lambda providers. |
Lambda (Legacy)
The old lambda provider is temporarily available in LocalstackĀ v2 using PROVIDER_OVERRIDE_LAMBDA=legacy but we highly recommend migrating to the new Lambda provider.
| Variable | Example Values | Description |
|---|---|---|
LAMBDA_EXECUTOR | Method to use for executing Lambda functions. For docker and docker-reuse, if LocalStack itself is started inside Docker, then the docker command needs to be available inside the container (usually requires to run the container in privileged mode). More information in Lambda Executor Modes.Removed in new provider. Mount the Docker socket or see migration guide. | |
docker (default) | Run each function invocation in a separate Docker container. | |
local (fallback) | Run Lambda functions in a temporary directory on the local machine. | |
docker-reuse | Create one Docker container per function and reuse it across invocations. | |
LAMBDA_STAY_OPEN_MODE | 1 (default) | Usage of the stay-open mode of Lambda containers. Only applicable if LAMBDA_EXECUTOR=docker-reuse. Set to 0 if you want to use Hot Reloading.Removed in new provider because stay-open mode is the default behavior. LAMBDA_KEEPALIVE_MS can be used to configure how long containers should be kept running in-between invocations. |
LAMBDA_REMOTE_DOCKER | determines whether Lambda code is copied or mounted into containers. Removed in new provider because zip file copying is used by default and hot reloading automatically configures mounting. | |
true (default) | your Lambda function definitions will be passed to the container by copying the zip file (potentially slower). It allows for remote execution, where the host and the client are not on the same machine. | |
false | your Lambda function definitions will be passed to the container by mounting a volume (potentially faster). This requires to have the Docker client and the Docker host on the same machine. | |
LAMBDA_TRUNCATE_STDOUT | 2000 (default) | Allows increasing the default char value for truncation of lambda logs. This does not affect the logs processing in CloudWatch. Still supported in new provider. |
BUCKET_MARKER_LOCAL | __local__ (default) | Optional bucket name for running lambdas locally. Still supported in new provider but default changed to hot-reload. |
LAMBDA_CODE_EXTRACT_TIME | 25 (default) | Time in seconds to wait at max while extracting Lambda code. By default, it is 25 seconds for limiting the execution time to avoid client/network timeout issues. Removed in new provider because function creation happens asynchronously. |
LAMBDA_DOCKER_NETWORK | Optional Docker network for the container running your lambda function. This configuration value also applies to ECS containers. Needs to be set to the network the LocalStack container is connected to. Still supported in new provider. | |
LAMBDA_DOCKER_DNS | Optional DNS server for the container running your lambda function. Supported in new provider since LocalStack 2.2. | |
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, ports, volume mounts, extra hosts, networks, labels, user, platform and privileged mode.Still supported in new provider. |
LAMBDA_CONTAINER_REGISTRY | lambci/lambda (default) | An alternative docker registry from where to pull lambda execution containers. Replaced by LAMBDA_RUNTIME_IMAGE_MAPPING in new provider. |
LAMBDA_REMOVE_CONTAINERS | 1 (default) | Whether to remove any Lambda Docker containers. Only applicable when using docker-reuse executor. Still supported in new provider. |
LAMBDA_FALLBACK_URL | Fallback URL to use when a non-existing Lambda is invoked. Either records invocations in DynamoDB (value dynamodb://<table_name>) or forwards invocations as a POST request (value http(s)://...).Removed in new provider. | |
LAMBDA_FORWARD_URL | URL used to forward all Lambda invocations (useful to run Lambdas via an external service). Removed in new provider. | |
LAMBDA_JAVA_OPTS | -Xmx512M | Allow passing custom JVM options to Java Lambdas executed in Docker. Use _debug_port_ placeholder to configure the debug port, e.g., -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=_debug_port_.Currently not supported in new provider but possible via custom entrypoint. |
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.Removed in new provider. |
LAMBDA_XRAY_INIT | 1 / 0 (default) | Whether to fully initialize XRay daemon for Lambda containers (may increase Lambda startup times). Removed in new provider because the X-Ray daemon is always initialized. |
SYNCHRONOUS_KINESIS_EVENTS | 1 (default) / 0 | Whether or not to handle Kinesis Lambda event sources as synchronous invocations. Removed in new provider. |
PROVIDER_OVERRIDE_LAMBDA | asf (optional) | Opt-in to use the new lambda provider beta. See Lambda providers. Active by default in the new provider. |
MWAA
| Variable | Example Values | Description |
|---|---|---|
MWAA_PIP_TRUSTED_HOSTS | pypi.org,files.pythonhosted.org | Comma-separated list of hosts for which SSL verification is not performed when installing Python dependencies for MWAA environment. |
OpenSearch
| Variable | Example Values | Description |
|---|---|---|
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). |
OPENSEARCH_MULTI_CLUSTER | 0|1 | 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. |
OPENSEARCH_ENDPOINT_STRATEGY | path|domain|port | Governs how domain endpoints are created to access a cluster (see Opensearch Endpoints). |
RDS
| Variable | Example Values | Description |
|---|---|---|
RDS_PG_CUSTOM_VERSIONS | 0 / 1 (default) | Whether to install and use custom Postgres versions for RDS (or alternatively, use default version 11). |
RDS_MYSQL_DOCKER | 0 (default) / 1 | Whether to enable MySQL engines (instead of MariaDB). Will run the MySQL cluster/instances in a new docker container. |
MYSQL_IMAGE | mysql:8.0 | Defines a specific MySQL image that should be used when spinning up the MySQL engine. Only available if RDS_MYSQL_DOCKER is enabled. |
MSSQL_IMAGE | mcr.microsoft.com/mssql/server:2022-latest | Defines a specific image that should be used when spinning up a SQL server engine. |
S3
| Variable | Example Values | Description |
|---|---|---|
S3_DIR | Configure a global parent directory that contains all buckets as sub-directories (S3_DIR=/path/to/root) or an individual directory that will get mounted as special bucket names (S3_DIR=/path/to/root/bucket1:bucket1). Only available for Localstack Pro. | |
S3_SKIP_SIGNATURE_VALIDATION | 0 / 1 (default) | Used to toggle validation of S3 pre-signed URL request signature. Set to 0 to validate. |
S3_SKIP_KMS_KEY_VALIDATION | 0 / 1 (default) | Used to toggle validation of provided KMS key in S3 operations. |
StepFunctions
| Variable | Example Values | Description |
|---|---|---|
STEPFUNCTIONS_LAMBDA_ENDPOINT | default | URL to use as the Lambda service endpoint in Step Functions. By default this is the LocalStack Lambda endpoint. Use default to select the original AWS Lambda endpoint. |
SQS
| Variable | Example Values | Description |
|---|---|---|
SQS_DELAY_PURGE_RETRY | 0 (default) | Used to toggle PurgeQueueInProgress errors when making more than one PurgeQueue call within 60 seconds. |
SQS_DELAY_RECENTLY_DELETED | 0 (default) | Used to toggle QueueDeletedRecently errors when re-creating a queue within 60 seconds of deleting it. |
SQS_ENDPOINT_STRATEGY | domain|path|off | Configures the format of Queue URLs (see SQS Queue URLs) |
SQS_DISABLE_CLOUDWATCH_METRICS | 0 (default) | Disables the CloudWatch Metrics for SQS when set to 1 |
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 |
Security
Warning
Please be aware that the following options may have severe security implications.| Variable | Example Values | Description |
|---|---|---|
DISABLE_CORS_HEADERS | 0 (default) | Whether to disable the returning of default CORS headers in API responses (disables access from https://app.localstack.cloud). |
DISABLE_CORS_CHECKS | 0 (default) | Whether to disable all CSRF (server-side) mitigations. |
DISABLE_CUSTOM_CORS_S3 | 0 (default) | Whether to disable CORS override by S3. |
DISABLE_CUSTOM_CORS_APIGATEWAY | 0 (default) | Whether to disable CORS override by apigateway. |
EXTRA_CORS_ALLOWED_ORIGINS | Comma-separated list of origins that are allowed to communicate with localstack. | |
EXTRA_CORS_ALLOWED_HEADERS | Comma-separated list of header names to be be added to Access-Control-Allow-Headers CORS header. | |
EXTRA_CORS_EXPOSE_HEADERS | Comma-separated list of header names to be be added to Access-Control-Expose-Headers CORS header. | |
ENABLE_CONFIG_UPDATES | 0 (default) | Whether to enable dynamic configuration updates at runtime. |
Emails
Please check with your SMTP email service provider for the following settings.
| Variable | Example Values | Description |
|---|---|---|
SMTP_HOST | localhost:1025 | Hostname (and optionally the port) of the SMTP server. The port defaults to 25. |
SMTP_USER | Login username for the SMTP server if required. | |
SMTP_PASS | Login password for the SMTP server if required. | |
SMTP_EMAIL | sender@example.com | Origin email address. Required for Cognito only. |
Persistence
To learn more about these configuration options, see Persistence.
| Variable | Valid options | Description |
|---|---|---|
SNAPSHOT_SAVE_STRATEGY | ON_SHUTDOWN|ON_REQUEST|SCHEDULED|MANUAL | Strategy that governs when LocalStack should make state snapshots |
SNAPSHOT_LOAD_STRATEGY | ON_STARTUP|ON_REQUEST|MANUAL | Strategy that governs when LocalStack restores state snapshots |
SNAPSHOT_FLUSH_INTERVAL | 15 (default) | The interval (in seconds) between persistence snapshots. It only applies to a SCHEDULED save strategy (see Persistence Mechanism) |
Miscellaneous
| Variable | Example Values | Description |
|---|---|---|
SKIP_SSL_CERT_DOWNLOAD | Whether to skip downloading the SSL certificate for localhost.localstack.cloud | |
CUSTOM_SSL_CERT_PATH | /var/lib/localstack/custom/server.test.pem | Defines the absolute path to a custom SSL certificate for localhost.localstack.cloud |
IGNORE_ES_DOWNLOAD_ERRORS | Whether to ignore errors (e.g., network/SSL) when downloading Elasticsearch plugins | |
OVERRIDE_IN_DOCKER | Overrides the check whether LocalStack is executed within a docker container. If set to true, LocalStack assumes it runs in a docker container. Should not be set unless necessary. | |
DISABLE_EVENTS | 1 | Whether to disable publishing LocalStack events |
OUTBOUND_HTTP_PROXY | http://10.10.1.3 | HTTP Proxy used for downloads of runtime dependencies and connections outside LocalStack itself |
OUTBOUND_HTTPS_PROXY | https://10.10.1.3 | HTTPS Proxy used for downloads of runtime dependencies and connections outside LocalStack itself |
REQUESTS_CA_BUNDLE | /var/lib/localstack/lib/ca_bundle.pem | CA Bundle to be used to verify HTTPS requests made by LocalStack |
Debugging
| Variable | Example Values | Description |
|---|---|---|
DEVELOP | Starts a debugpy server before starting LocalStack services | |
DEVELOP_PORT | Port number for debugpy server | |
WAIT_FOR_DEBUGGER | Forces LocalStack to wait for a debugger to start the services |
DNS
To learn more about these configuration options, see DNS Server.
| Variable | Example Values | Description |
|---|---|---|
DNS_ADDRESS | 0.0.0.0 (default) | Address the LocalStack should bind the DNS server on (port 53 tcp/udp). Value 0 to disable. |
DNS_SERVER | 8.8.8.8 (default) | Fallback DNS server for non-modified queries. |
DNS_RESOLVE_IP | 127.0.0.1 | IP address the DNS integration should return as A record for modified queries. This will override any automatic detection of the proper response IP. |
DNS_LOCAL_NAME_PATTERNS | Names which should be resolved to the LocalStack IP, as python-compatible regex. |
LocalStack Pro
| Variable | Example Values | Description |
|---|---|---|
ACTIVATE_PRO | 1 (default) | Whether pro should be activated or not. This is set to true by default if using the localstack/localstack-pro container image. If set to 1, LocalStack will fail to start if the license key activation did not work. If set to 0, an attempt is made to start LocalStack without pro features. |
LOCALSTACK_API_KEY | API key to activate LocalStack Pro. | |
LOG_LICENSE_ISSUES | 1 (default) | Whether to log issues with the license activation to the console. |
Deprecated
These configurations are deprecated and will be removed in the upcoming major version.
| Variable | Example Values | Description |
|---|---|---|
USE_SSL | false (default) | Deprecated. Whether to use https://… URLs with SSL encryption. Deprecated as of version 0.11.3. Each service endpoint now supports multiplexing HTTP/HTTPS traffic over the same port. |
DEFAULT_REGION | Deprecated. AWS region to use when talking to the API (needs to be activated via USE_SINGLE_REGION=1). LocalStack now has full multi-region support. | |
USE_SINGLE_REGION | Deprecated. Whether to use the legacy single-region mode, defined via DEFAULT_REGION. | |
DATA_DIR | blank (disabled/default), /tmp/localstack/data | Deprecated. Local directory for saving persistent data. This option is deprecated since LocalStack v1 and will be ignored. Please use PERSISTENCE. Using this option will set PERSISTENCE=1 as a deprecation path. The state will be stored in your LocalStack volume in the state/ directory |
HOST_TMP_FOLDER | /some/path | Deprecated. 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. |
TMPDIR | /tmp (default) | Deprecated. Temporary folder on the host running the CLI and inside the LocalStack container . |
<SERVICE>_BACKEND | Deprecated. Custom endpoint URL to use for a specific service, where <SERVICE> is the uppercase service name. | |
<SERVICE>_PORT_EXTERNAL | 4567 | Deprecated. Port number to expose a specific service externally . SQS_PORT_EXTERNAL, e.g. , is used when returning queue URLs from the SQS service to the client. |
LOCALSTACK_HOSTNAME | http://${LOCALSTACK_HOSTNAME}:4566 | Deprecated. Name of the host where LocalStack services are available. Use this hostname as endpoint in order to access the services from within your Lambda functions (e.g., to store an item to DynamoDB or S3 from a Lambda). This option is read-only. Use LOCALSTACK_HOST instead. |
HOSTNAME_EXTERNAL | localhost (default) | Deprecated. Name of the host to expose the services externally. This host is used, e.g., when returning queue URLs from the SQS service to the client. Use LOCALSTACK_HOST instead. |
EDGE_BIND_HOST | 127.0.0.1 (default), 0.0.0.0 (docker) | Deprecated. Address the edge service binds to. Use GATEWAY_LISTEN instead. |
EDGE_PORT | 4566 (default) | Deprecated. Port number for the edge service, the main entry point for all API invocations. |
EDGE_FORWARD_URL | Deprecated. Optional target URL to forward all edge requests to (e.g., for distributed deployments) | |
INIT_SCRIPTS_PATH | /some/path | Deprecated. 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. |
KMS_PROVIDER | moto (default), local-kms | Deprecated. local-kms provider is deprecated and marked for removal. |
ES_CUSTOM_BACKEND | http://elasticsearch:9200 | Deprecated. Use OPENSEARCH_CUSTOM_BACKEND instead. URL to a custom elasticsearch backend cluster. If this is set to a valid URL, then localstack will not create elasticsearch cluster instances, but instead forward all domains to the given backend (see Custom Elasticsearch Backends). |
ES_MULTI_CLUSTER | 0|1 | Deprecated. Use OPENSEARCH_MULTI_CLUSTER instead. When activated, LocalStack will spawn one Elasticsearch cluster per domain. Otherwise all domains will share a single cluster instance. This is ignored if ES_CUSTOM_BACKEND is set. |
ES_ENDPOINT_STRATEGY | path|domain|port (formerly off) | Deprecated. Use OPENSEARCH_ENDPOINT_STRATEGY instead. Governs how domain endpoints are created to access a cluster (see Elasticsearch Endpoints) |
SKIP_INFRA_DOWNLOADS | Deprecated. Whether to skip downloading additional infrastructure components (e.g., specific Elasticsearch versions) | |
MOCK_UNIMPLEMENTED | Deprecated. Whether to return mocked success responses (instead of 501 errors) for currently unimplemented API methods |
Profiles
LocalStack supports configuration profiles which are stored in the ~/.localstack config directory.
+Please consult the page Lambda providers for more information.
| Variable | Example Values | Description |
|---|---|---|
BUCKET_MARKER_LOCAL | hot-reload (default) | Magic S3 bucket name for Hot Reloading. The S3Key points to the source code on the local file system. |
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, ports, volume mounts, extra hosts, networks, DNS servers, labels, ulimits, user, platform, and privileged mode. |
LAMBDA_DOCKER_NETWORK | bridge (Docker default) | Docker network driver 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. |
LAMBDA_DOWNLOAD_AWS_LAYERS | 1 (default, pro) | Whether to download public Lambda layers from AWS through a LocalStack proxy when creating or updating functions. |
LAMBDA_IGNORE_ARCHITECTURE | 0 (default) | Whether to ignore the AWS architectures (x86_64 or arm64) configured for the lambda function. Set to 1 to run cross-platform compatible lambda functions natively (i.e., Docker selects architecture). |
LAMBDA_K8S_IMAGE_PREFIX | amazon/aws-lambda- (default, pro) | Prefix for images that will be used to execute Lambda functions in Kubernetes. |
LAMBDA_KEEPALIVE_MS | 600000 (default 10min) | Time in milliseconds until lambda shuts down the execution environment after the last invocation has been processed. Set to 0 to immediately shut down the execution environment after an invocation. |
LAMBDA_LIMITS_CONCURRENT_EXECUTIONS | 1000 (default) | The maximum number of events that functions can process simultaneously in the current Region. See AWS service quotas |
LAMBDA_REMOVE_CONTAINERS | 1 (default) | Whether to remove any Lambda Docker containers. |
LAMBDA_RUNTIME_ENVIRONMENT_TIMEOUT | 10 (default) | How many seconds Lambda will wait for the runtime environment to start up. |
LAMBDA_RUNTIME_EXECUTOR | docker (default) | Where Lambdas will be executed. |
kubernetes (pro) | Execute lambdas in a Kubernetes cluster. | |
LAMBDA_RUNTIME_IMAGE_MAPPING | base images for Lambda (default) | Customize the Docker image of Lambda runtimes, either by: a) pattern with <runtime> placeholder, e.g. custom-repo/lambda-<runtime>:2022b) json dict mapping the <runtime> to an image, e.g. {"python3.9": "custom-repo/lambda-py:thon3.9"} |
LAMBDA_SYNCHRONOUS_CREATE | 0 (default) | Set to 1 to create lambda functions synchronously (not recommended). |
LAMBDA_TRUNCATE_STDOUT | 2000 (default) | Allows increasing the default char limit for truncation of lambda log lines when printed in the console. This does not affect the logs processing in CloudWatch. |
PROVIDER_OVERRIDE_LAMBDA | v2 (default) | Currently supported implementation of our local Lambda service active since LocalStackĀ 2.0 (Docker latest since 2023-03-23). |
legacy (deprecated) | Use the old lambda provider (not recommended). See Lambda providers. |
Lambda (Legacy)
The old lambda provider is temporarily available in LocalstackĀ v2 using PROVIDER_OVERRIDE_LAMBDA=legacy but we highly recommend migrating to the new Lambda provider.
| Variable | Example Values | Description |
|---|---|---|
LAMBDA_EXECUTOR | Method to use for executing Lambda functions. For docker and docker-reuse, if LocalStack itself is started inside Docker, then the docker command needs to be available inside the container (usually requires to run the container in privileged mode). More information in Lambda Executor Modes.Removed in new provider. Mount the Docker socket or see migration guide. | |
docker (default) | Run each function invocation in a separate Docker container. | |
local (fallback) | Run Lambda functions in a temporary directory on the local machine. | |
docker-reuse | Create one Docker container per function and reuse it across invocations. | |
LAMBDA_STAY_OPEN_MODE | 1 (default) | Usage of the stay-open mode of Lambda containers. Only applicable if LAMBDA_EXECUTOR=docker-reuse. Set to 0 if you want to use Hot Reloading.Removed in new provider because stay-open mode is the default behavior. LAMBDA_KEEPALIVE_MS can be used to configure how long containers should be kept running in-between invocations. |
LAMBDA_REMOTE_DOCKER | determines whether Lambda code is copied or mounted into containers. Removed in new provider because zip file copying is used by default and hot reloading automatically configures mounting. | |
true (default) | your Lambda function definitions will be passed to the container by copying the zip file (potentially slower). It allows for remote execution, where the host and the client are not on the same machine. | |
false | your Lambda function definitions will be passed to the container by mounting a volume (potentially faster). This requires to have the Docker client and the Docker host on the same machine. | |
LAMBDA_TRUNCATE_STDOUT | 2000 (default) | Allows increasing the default char value for truncation of lambda logs. This does not affect the logs processing in CloudWatch. Still supported in new provider. |
BUCKET_MARKER_LOCAL | __local__ (default) | Optional bucket name for running lambdas locally. Still supported in new provider but default changed to hot-reload. |
LAMBDA_CODE_EXTRACT_TIME | 25 (default) | Time in seconds to wait at max while extracting Lambda code. By default, it is 25 seconds for limiting the execution time to avoid client/network timeout issues. Removed in new provider because function creation happens asynchronously. |
LAMBDA_DOCKER_NETWORK | Optional Docker network for the container running your lambda function. This configuration value also applies to ECS containers. Needs to be set to the network the LocalStack container is connected to. Still supported in new provider. | |
LAMBDA_DOCKER_DNS | Optional DNS server for the container running your lambda function. Supported in new provider since LocalStack 2.2. | |
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, ports, volume mounts, extra hosts, networks, labels, user, platform and privileged mode.Still supported in new provider. |
LAMBDA_CONTAINER_REGISTRY | lambci/lambda (default) | An alternative docker registry from where to pull lambda execution containers. Replaced by LAMBDA_RUNTIME_IMAGE_MAPPING in new provider. |
LAMBDA_REMOVE_CONTAINERS | 1 (default) | Whether to remove any Lambda Docker containers. Only applicable when using docker-reuse executor. Still supported in new provider. |
LAMBDA_FALLBACK_URL | Fallback URL to use when a non-existing Lambda is invoked. Either records invocations in DynamoDB (value dynamodb://<table_name>) or forwards invocations as a POST request (value http(s)://...).Removed in new provider. | |
LAMBDA_FORWARD_URL | URL used to forward all Lambda invocations (useful to run Lambdas via an external service). Removed in new provider. | |
LAMBDA_JAVA_OPTS | -Xmx512M | Allow passing custom JVM options to Java Lambdas executed in Docker. Use _debug_port_ placeholder to configure the debug port, e.g., -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=_debug_port_.Currently not supported in new provider but possible via custom entrypoint. |
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.Removed in new provider. |
LAMBDA_XRAY_INIT | 1 / 0 (default) | Whether to fully initialize XRay daemon for Lambda containers (may increase Lambda startup times). Removed in new provider because the X-Ray daemon is always initialized. |
SYNCHRONOUS_KINESIS_EVENTS | 1 (default) / 0 | Whether or not to handle Kinesis Lambda event sources as synchronous invocations. Removed in new provider. |
PROVIDER_OVERRIDE_LAMBDA | asf (optional) | Opt-in to use the new lambda provider beta. See Lambda providers. Active by default in the new provider. |
MWAA
| Variable | Example Values | Description |
|---|---|---|
MWAA_PIP_TRUSTED_HOSTS | pypi.org,files.pythonhosted.org | Comma-separated list of hosts for which SSL verification is not performed when installing Python dependencies for MWAA environment. |
OpenSearch
| Variable | Example Values | Description |
|---|---|---|
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). |
OPENSEARCH_MULTI_CLUSTER | 0|1 | 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. |
OPENSEARCH_ENDPOINT_STRATEGY | path|domain|port | Governs how domain endpoints are created to access a cluster (see Opensearch Endpoints). |
RDS
| Variable | Example Values | Description |
|---|---|---|
RDS_PG_CUSTOM_VERSIONS | 0 / 1 (default) | Whether to install and use custom Postgres versions for RDS (or alternatively, use default version 11). |
RDS_MYSQL_DOCKER | 0 (default) / 1 | Whether to enable MySQL engines (instead of MariaDB). Will run the MySQL cluster/instances in a new docker container. |
MYSQL_IMAGE | mysql:8.0 | Defines a specific MySQL image that should be used when spinning up the MySQL engine. Only available if RDS_MYSQL_DOCKER is enabled. |
MSSQL_IMAGE | mcr.microsoft.com/mssql/server:2022-latest | Defines a specific image that should be used when spinning up a SQL server engine. |
S3
| Variable | Example Values | Description |
|---|---|---|
S3_DIR | Configure a global parent directory that contains all buckets as sub-directories (S3_DIR=/path/to/root) or an individual directory that will get mounted as special bucket names (S3_DIR=/path/to/root/bucket1:bucket1). Only available for Localstack Pro. | |
S3_SKIP_SIGNATURE_VALIDATION | 0 / 1 (default) | Used to toggle validation of S3 pre-signed URL request signature. Set to 0 to validate. |
S3_SKIP_KMS_KEY_VALIDATION | 0 / 1 (default) | Used to toggle validation of provided KMS key in S3 operations. |
PROVIDER_OVERRIDE_S3 | v3 | Activate the new LocalStack-native S3 provider. |
StepFunctions
| Variable | Example Values | Description |
|---|---|---|
STEPFUNCTIONS_LAMBDA_ENDPOINT | default | URL to use as the Lambda service endpoint in Step Functions. By default this is the LocalStack Lambda endpoint. Use default to select the original AWS Lambda endpoint. |
PROVIDER_OVERRIDE_STEPFUNCTIONS | v2 | Activate the new LocalStack-native StepFunctions provider. |
SQS
| Variable | Example Values | Description |
|---|---|---|
SQS_DELAY_PURGE_RETRY | 0 (default) | Used to toggle PurgeQueueInProgress errors when making more than one PurgeQueue call within 60 seconds. |
SQS_DELAY_RECENTLY_DELETED | 0 (default) | Used to toggle QueueDeletedRecently errors when re-creating a queue within 60 seconds of deleting it. |
SQS_ENDPOINT_STRATEGY | domain|path|off | Configures the format of Queue URLs (see SQS Queue URLs) |
SQS_DISABLE_CLOUDWATCH_METRICS | 0 (default) | Disables the CloudWatch Metrics for SQS when set to 1 |
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 |
Security
Warning
Please be aware that the following options may have severe security implications.| Variable | Example Values | Description |
|---|---|---|
DISABLE_CORS_HEADERS | 0 (default) | Whether to disable the returning of default CORS headers in API responses (disables access from https://app.localstack.cloud). |
DISABLE_CORS_CHECKS | 0 (default) | Whether to disable all CSRF (server-side) mitigations. |
DISABLE_CUSTOM_CORS_S3 | 0 (default) | Whether to disable CORS override by S3. |
DISABLE_CUSTOM_CORS_APIGATEWAY | 0 (default) | Whether to disable CORS override by apigateway. |
EXTRA_CORS_ALLOWED_ORIGINS | Comma-separated list of origins that are allowed to communicate with localstack. | |
EXTRA_CORS_ALLOWED_HEADERS | Comma-separated list of header names to be be added to Access-Control-Allow-Headers CORS header. | |
EXTRA_CORS_EXPOSE_HEADERS | Comma-separated list of header names to be be added to Access-Control-Expose-Headers CORS header. | |
ENABLE_CONFIG_UPDATES | 0 (default) | Whether to enable dynamic configuration updates at runtime. |
Emails
Please check with your SMTP email service provider for the following settings.
| Variable | Example Values | Description |
|---|---|---|
SMTP_HOST | localhost:1025 | Hostname (and optionally the port) of the SMTP server. The port defaults to 25. |
SMTP_USER | Login username for the SMTP server if required. | |
SMTP_PASS | Login password for the SMTP server if required. | |
SMTP_EMAIL | sender@example.com | Origin email address. Required for Cognito only. |
Persistence
To learn more about these configuration options, see Persistence.
| Variable | Valid options | Description |
|---|---|---|
SNAPSHOT_SAVE_STRATEGY | ON_SHUTDOWN|ON_REQUEST|SCHEDULED|MANUAL | Strategy that governs when LocalStack should make state snapshots |
SNAPSHOT_LOAD_STRATEGY | ON_STARTUP|ON_REQUEST|MANUAL | Strategy that governs when LocalStack restores state snapshots |
SNAPSHOT_FLUSH_INTERVAL | 15 (default) | The interval (in seconds) between persistence snapshots. It only applies to a SCHEDULED save strategy (see Persistence Mechanism) |
Miscellaneous
| Variable | Example Values | Description |
|---|---|---|
SKIP_SSL_CERT_DOWNLOAD | Whether to skip downloading the SSL certificate for localhost.localstack.cloud | |
CUSTOM_SSL_CERT_PATH | /var/lib/localstack/custom/server.test.pem | Defines the absolute path to a custom SSL certificate for localhost.localstack.cloud |
IGNORE_ES_DOWNLOAD_ERRORS | Whether to ignore errors (e.g., network/SSL) when downloading Elasticsearch plugins | |
OVERRIDE_IN_DOCKER | Overrides the check whether LocalStack is executed within a docker container. If set to true, LocalStack assumes it runs in a docker container. Should not be set unless necessary. | |
DISABLE_EVENTS | 1 | Whether to disable publishing LocalStack events |
OUTBOUND_HTTP_PROXY | http://10.10.1.3 | HTTP Proxy used for downloads of runtime dependencies and connections outside LocalStack itself |
OUTBOUND_HTTPS_PROXY | https://10.10.1.3 | HTTPS Proxy used for downloads of runtime dependencies and connections outside LocalStack itself |
REQUESTS_CA_BUNDLE | /var/lib/localstack/lib/ca_bundle.pem | CA Bundle to be used to verify HTTPS requests made by LocalStack |
Debugging
| Variable | Example Values | Description |
|---|---|---|
DEVELOP | Starts a debugpy server before starting LocalStack services | |
DEVELOP_PORT | Port number for debugpy server | |
WAIT_FOR_DEBUGGER | Forces LocalStack to wait for a debugger to start the services |
DNS
To learn more about these configuration options, see DNS Server.
| Variable | Example Values | Description |
|---|---|---|
DNS_ADDRESS | 0.0.0.0 (default) | Address the LocalStack should bind the DNS server on (port 53 tcp/udp). Value 0 to disable. |
DNS_SERVER | 8.8.8.8 (default) | Fallback DNS server for non-modified queries. |
DNS_RESOLVE_IP | 127.0.0.1 | IP address the DNS integration should return as A record for modified queries. This will override any automatic detection of the proper response IP. |
DNS_LOCAL_NAME_PATTERNS | Names which should be resolved to the LocalStack IP, as python-compatible regex. |
LocalStack Pro
| Variable | Example Values | Description |
|---|---|---|
ACTIVATE_PRO | 1 (default) | Whether pro should be activated or not. This is set to true by default if using the localstack/localstack-pro container image. If set to 1, LocalStack will fail to start if the license key activation did not work. If set to 0, an attempt is made to start LocalStack without pro features. |
LOCALSTACK_API_KEY | API key to activate LocalStack Pro. | |
LOG_LICENSE_ISSUES | 1 (default) | Whether to log issues with the license activation to the console. |
Deprecated
These configurations are deprecated and will be removed in the upcoming major version.
| Variable | Example Values | Description |
|---|---|---|
USE_SSL | false (default) | Deprecated. Whether to use https://… URLs with SSL encryption. Deprecated as of version 0.11.3. Each service endpoint now supports multiplexing HTTP/HTTPS traffic over the same port. |
DEFAULT_REGION | Deprecated. AWS region to use when talking to the API (needs to be activated via USE_SINGLE_REGION=1). LocalStack now has full multi-region support. | |
USE_SINGLE_REGION | Deprecated. Whether to use the legacy single-region mode, defined via DEFAULT_REGION. | |
DATA_DIR | blank (disabled/default), /tmp/localstack/data | Deprecated. Local directory for saving persistent data. This option is deprecated since LocalStack v1 and will be ignored. Please use PERSISTENCE. Using this option will set PERSISTENCE=1 as a deprecation path. The state will be stored in your LocalStack volume in the state/ directory |
HOST_TMP_FOLDER | /some/path | Deprecated. 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. |
TMPDIR | /tmp (default) | Deprecated. Temporary folder on the host running the CLI and inside the LocalStack container . |
<SERVICE>_BACKEND | Deprecated. Custom endpoint URL to use for a specific service, where <SERVICE> is the uppercase service name. | |
<SERVICE>_PORT_EXTERNAL | 4567 | Deprecated. Port number to expose a specific service externally . SQS_PORT_EXTERNAL, e.g. , is used when returning queue URLs from the SQS service to the client. |
LOCALSTACK_HOSTNAME | http://${LOCALSTACK_HOSTNAME}:4566 | Deprecated. Name of the host where LocalStack services are available. Use this hostname as endpoint in order to access the services from within your Lambda functions (e.g., to store an item to DynamoDB or S3 from a Lambda). This option is read-only. Use LOCALSTACK_HOST instead. |
HOSTNAME_EXTERNAL | localhost (default) | Deprecated. Name of the host to expose the services externally. This host is used, e.g., when returning queue URLs from the SQS service to the client. Use LOCALSTACK_HOST instead. |
EDGE_BIND_HOST | 127.0.0.1 (default), 0.0.0.0 (docker) | Deprecated. Address the edge service binds to. Use GATEWAY_LISTEN instead. |
EDGE_PORT | 4566 (default) | Deprecated. Port number for the edge service, the main entry point for all API invocations. |
EDGE_FORWARD_URL | Deprecated. Optional target URL to forward all edge requests to (e.g., for distributed deployments) | |
INIT_SCRIPTS_PATH | /some/path | Deprecated. 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. |
KMS_PROVIDER | moto (default), local-kms | Deprecated. local-kms provider is deprecated and marked for removal. |
ES_CUSTOM_BACKEND | http://elasticsearch:9200 | Deprecated. Use OPENSEARCH_CUSTOM_BACKEND instead. URL to a custom elasticsearch backend cluster. If this is set to a valid URL, then localstack will not create elasticsearch cluster instances, but instead forward all domains to the given backend (see Custom Elasticsearch Backends). |
ES_MULTI_CLUSTER | 0|1 | Deprecated. Use OPENSEARCH_MULTI_CLUSTER instead. When activated, LocalStack will spawn one Elasticsearch cluster per domain. Otherwise all domains will share a single cluster instance. This is ignored if ES_CUSTOM_BACKEND is set. |
ES_ENDPOINT_STRATEGY | path|domain|port (formerly off) | Deprecated. Use OPENSEARCH_ENDPOINT_STRATEGY instead. Governs how domain endpoints are created to access a cluster (see Elasticsearch Endpoints) |
SKIP_INFRA_DOWNLOADS | Deprecated. Whether to skip downloading additional infrastructure components (e.g., specific Elasticsearch versions) | |
MOCK_UNIMPLEMENTED | Deprecated. Whether to return mocked success responses (instead of 501 errors) for currently unimplemented API methods | |
ACTIVATE_NEW_POD_CLIENT | 0|1 (default) | Deprecated. Whether to use the new Cloud Pods client leveraging LocalStack container’s APIs. |
BIGDATA_MONO_CONTAINER | 0|1 (default) | Deprecated. Whether to spin Big Data services inside the LocalStack main container. Glue jobs breaks when using BIGDATA_MONO_CONTAINER=0. |
Profiles
LocalStack supports configuration profiles which are stored in the ~/.localstack config directory.
A configuration profile is a set of environment variables stored in an .env file in the LocalStack config directory.
Here is an example of what configuration profiles might look like:
$ tree ~/.localstack
/home/username/.localstack
āāā default.env
@@ -297,7 +297,7 @@
Let’s take an example to load the dev.env profile file if it exists:$ python -m localstack.cli.main --profile=dev start
If no profile is specified, the default.env profile will be loaded.
While explicitly specified, the environment variables will always overwrite the profile.
To display the config environment variables, you can use the following command:
$ python -m localstack.cli.main --profile=dev config show
Note
The CONFIG_PROFILE is a CLI feature and cannot be used with a Docker/Docker Compose setup.
You can look at alternative means of setting environment variables for your Docker Compose setups.
-For Docker setups, we recommend passing the environment variables directly to the docker run command.
Last modified September 11, 2023: fix Configuration `INIT_SCRIPTS_PATH` Description (#654) (bba0a397a)docker run command.Last modified September 28, 2023: Update user docs to v2.3 (#836) (fcf779c23)