localstack/localstack-pro
LocalStack Pro is an easy-to-use cloud emulation framework for dev, testing, and experimentation!
1M+
LocalStack is a cloud service emulator that runs in a single container on your laptop or in your CI environment. With LocalStack, you can run your AWS applications or Lambdas entirely on your local machine without connecting to a remote cloud provider! Whether you are testing complex CDK applications or Terraform configurations, or just beginning to learn about AWS services, LocalStack helps speed up and simplify your testing and development workflow.
LocalStack Pro contains various advanced extensions to the LocalStack base platform, which is open-source and community driven. LocalStack Pro is available as a Docker image. You can read more about it on our documentation for Docker images.
LocalStack also provides additional features to make your life as a cloud developer easier! Check out LocalStack's Cloud Developer Tools for more information.
To install LocalStack Pro, refer to our installation guide and API Key guide.
If you are using the LocalStack Community edition, you can upgrade to LocalStack Pro by pulling the latest
tag of the LocalStack Pro Docker image. Depending on how you start LocalStack, here’s what you need to look out for:
image
property of your service container from localstack/localstack
to localstack/localstack-pro
.localstack/localstack-pro
as the image you want to start.LocalStack Pro image includes Pro services and several advanced features. You need to provide an Auth Token to start the LocalStack Pro image successfully. The Auth Token is a personal identifier used for user authentication outside the LocalStack Web Application, particularly in conjunction with the LocalStack core cloud emulator. Its primary functions are to retrieve the user’s license and enable access to advanced features. You can find more information on how to setup an Auth Token on our Auth Token documentation. You can locate your Auth Token on the Auth Token page in the LocalStack Web Application.
To start using LocalStack, check out our documentation at docs.localstack.cloud.
To use LocalStack with a graphical user interface, you can use the following UI clients:
You can start LocalStack with Docker Compose by configuring a docker-compose.yml
file. Currently, docker-compose version 1.9.0+ is supported.
version: "3.8"
services:
localstack:
container_name: "${LOCALSTACK_DOCKER_NAME:-localstack-main}"
image: localstack/localstack-pro
ports:
- "127.0.0.1:4566:4566" # LocalStack Gateway
- "127.0.0.1:4510-4559:4510-4559" # external services port range
environment:
# LocalStack configuration: https://docs.localstack.cloud/references/configuration/
- DEBUG=${DEBUG:-0}
volumes:
- "${LOCALSTACK_VOLUME_DIR:-./volume}:/var/lib/localstack"
- "/var/run/docker.sock:/var/run/docker.sock"
Start the container by running the following command:
$ docker-compose up
Create an ECR registry with LocalStack's awslocal
CLI:
awslocal ecr create-repository --repository-name test-repository
awslocal ecr describe-repositories --repository-name test-repository
Notes
This command pulls the latest image that is built on every commit. Please refer to Base Image Tags to select the image tag you want to use.
Mounting the Docker socket /var/run/docker.sock
as a volume is required for the Lambda service. Check out the Lambda providers documentation for more information.
Please note that there are a few pitfalls when configuring your stack manually via docker-compose (e.g., required container name, Docker network, volume mounts, and environment variables). We recommend using the LocalStack CLI to validate your configuration, which will print warning messages in case it detects any potential misconfigurations:
$ localstack config validate
You can directly start the LocalStack container using the Docker CLI. This method requires more manual steps and configuration, but it gives you more control over the container settings.
You can start the Docker container simply by executing the following docker run command:
$ docker run --rm -it -p 4566:4566 -p 4510-4559:4510-4559 localstack/localstack-pro
Create a CloudFormation Stack named as cfn-quickstart-stack.yaml
.
{
"Resources": {
"LocalBucket": {
"Type": "AWS::S3::Bucket",
"Properties": {
"BucketName": "cfn-quickstart-bucket"
}
}
}
}
You can deploy the CloudFormation stack using the AWS CLI with the deploy command. The deploy command creates and updates CloudFormation stacks. Run the following command to deploy the stack:
awslocal cloudformation deploy \
--stack-name cfn-quickstart-stack \
--template-file "./cfn-quickstart-stack.yaml"
Notes
This command reuses the image if it’s already on your machine, i.e. it will not pull the latest image automatically from Docker Hub.
This command does not bind all ports that are potentially used by LocalStack, nor does it mount any volumes. When using Docker to manually start LocalStack, you will have to configure the container on your own (see docker-compose.yml
and Configuration). This could be seen as the “expert mode” of starting LocalStack. If you are looking for a simpler method of starting LocalStack, please use the LocalStack CLI.
Please refer to GitHub releases to see the complete list of changes for each release. For extended release notes, please refer to the changelog.
We do push a set of different image tags for the LocalStack Docker images. When using LocalStack, you can decide which tag you want to use.These tags have different semantics and will be updated on different occasions:
latest
(default)
stable
<major>
(e.g. 3
)
<major>.<minor>
(e.g. 3.0
)
<major>.<minor>.<patch>
(e.g. 3.0.2
)
Get in touch with the LocalStack Team to report 🐞 issues, upvote 👍 feature requests, 🙋🏽 ask support questions, or 🗣️ discuss local cloud development:
docker pull localstack/localstack-pro