Back to all templates
LocalStack logo

LocalStack

Development1024MB+ RAM

Local AWS cloud stack for development

awslocaldevelopmenttesting

Deploy LocalStack in 3 Steps

1

Connect Your VPS

Add your server credentials to Server Compass

2

Select LocalStack

Choose from our template library

3

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required
Step-by-step deployment guide

Deploy LocalStack on a VPS with Server Compass

Use the LocalStack template in Server Compass to deploy a local AWS-compatible development endpoint on your VPS, then verify the LocalStack health API in a browser.

About 7 minutesBrowser verified
1
Step 1

Open the server Apps tab

Select your VPS, open the Apps tab, and start a new app deployment. Keep sensitive server details hidden before capturing or sharing screenshots.

Server Compass Apps tab before creating a LocalStack app
2
Step 2

Choose an app template

Click New App and choose the template deployment path so Server Compass can load the built-in catalog.

Choosing to deploy an app from a Server Compass template
3
Step 3

Search for LocalStack

Use the template picker search to find LocalStack in the Server Compass template catalog.

Searching for LocalStack in the Server Compass template picker
4
Step 4

Select the LocalStack template

Choose the LocalStack template. Server Compass fills the LocalStack gateway service, enabled services list, persistence setting, and data volume.

LocalStack template selected in Server Compass
5
Step 5

Review the LocalStack settings

Confirm the app name and compose services. In this run, the app was named localstack-demo and used host port 4566.

Reviewing LocalStack project settings and compose services
6
Step 6

Deploy LocalStack

Review the generated environment values, confirm the port is available, and click Deploy Now.

Reviewing LocalStack environment variables and port before deployment
7
Step 7

Watch the deployment progress

Keep the deployment modal open while Server Compass uploads the compose file, pulls the LocalStack image, starts the container, and verifies the stack.

Server Compass deploying the LocalStack template on the VPS
8
Step 8

Confirm LocalStack is running

After deployment finishes, return to the Apps tab and confirm the LocalStack app is marked Running with its gateway URL available.

LocalStack template running in the Server Compass Apps tab
9
Step 9

Open the LocalStack health API

Open the LocalStack health endpoint in a browser. A successful JSON response confirms the AWS-compatible gateway is reachable.

The deployed LocalStack health API responding in a browser

After LocalStack Opens

  • Point AWS SDKs or the AWS CLI at the LocalStack endpoint with `--endpoint-url`.
  • Use LocalStack for development and testing, not as a production AWS replacement.
  • Restrict network access before exposing the gateway outside a private development network.
  • Back up the LocalStack data volume if you rely on persisted development state.

Verified Result

The LocalStack health endpoint responded successfully in a browser.

LocalStack deployment questions

What does the LocalStack template deploy?

It deploys the LocalStack container with persistence enabled, Docker socket access, and selected AWS-compatible services.

Which port did the tutorial use?

The tutorial verified LocalStack on host port 4566, which maps to the LocalStack gateway on container port 4566.

Why does the guide verify an API endpoint instead of a web UI?

LocalStack is an AWS-compatible API gateway for development. The health endpoint is the correct browser-safe verification target.

Should this become a blog post?

No. The deployment guide should live on the LocalStack template detail page and be linked from the reusable template deployment docs page.

Manual Setup Guide

Set Up LocalStack from Terminal

Get your hands dirty: manual LocalStack deployment guide for developers.

1

Connect to Your VPS via SSH

Fire up your terminal application and establish a connection to your remote server.

terminal
# Access your VPS
ssh root@YOUR_SERVER_IP

# With SSH key authentication
ssh -i ~/.ssh/your-private-key root@YOUR_SERVER_IP

First time? Ensure Docker is installed first: curl -fsSL https://get.docker.com | sh

2

Initialize Project Folder

Create a folder to house your Docker Compose configuration.

terminal
# Create and navigate to project directory
mkdir -p ~/apps/localstack
cd ~/apps/localstack
3

Create Docker Configuration

Define your services in a docker-compose.yml file:

docker-compose.yml
services:
  localstack:
    image: localstack/localstack:latest
    ports:
      - "4566:4566"
    environment:
      - SERVICES=s3,sqs,dynamodb,lambda
      - DEBUG=1
      - PERSISTENCE=1
    volumes:
      - localstack_data:/var/lib/localstack
      - /var/run/docker.sock:/var/run/docker.sock
    restart: unless-stopped

volumes:
  localstack_data:
Environment Variables
PORTGateway port(default: 4566)
SERVICESServices(default: s3,sqs,dynamodb,lambda)
4

Execute the Deployment

Start your containers and verify they're running correctly.

terminal
# Launch the stack
docker compose up -d

# Verify container status
docker compose ps

# Follow the logs
docker compose logs --follow
5

Allow Network Access

Update UFW rules to allow traffic on the application port.

terminal
# Allow the application port through firewall
sudo ufw allow 4566/tcp
sudo ufw reload

# Access your app at:
# http://your-server-ip:4566
Skip the Terminal

Don't want to type commands? We've got you.

Why type commands when you can click? Deploy LocalStack the easy way with Server Compass.

  • No terminal required
  • Point-and-click setup
  • Auto SSL certificates
  • Rolling deployments
  • Health monitoring
  • Instant rollbacks
Download Server Compass$29 one-time • Lifetime license

After Deployment

After deploying LocalStack with Server Compass, complete these steps to finish setup

1

Configure AWS CLI

2

Use --endpoint-url

3

Test with AWS commands

Need help? Check out our documentation for detailed guides.

LocalStack FAQ

Common questions about self-hosting LocalStack

How do I deploy LocalStack with Server Compass?

Simply download Server Compass, connect to your VPS, and select LocalStack from the templates list. Fill in the required configuration and click Deploy. The entire process takes under 3 minutes.

What are the system requirements for LocalStack?

LocalStack requires a minimum of 1024MB RAM. We recommend a VPS with at least 2048MB RAM for optimal performance. Any modern Linux server with Docker support will work.

Can I migrate my existing LocalStack data?

Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard LocalStack backup and restore procedures.

How do I update LocalStack to the latest version?

Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest LocalStack image will be pulled and deployed with zero downtime.

Is LocalStack free to self-host?

LocalStack is open-source software. You only pay for your VPS hosting (typically $5-20/month) and optionally Server Compass ($29 one-time). No subscription fees or per-seat pricing.

Ready to Self-Host LocalStack?

Download Server Compass and deploy LocalStack to your VPS in under 3 minutes. No Docker expertise required.

Download Server Compass