Skip to content

Update configuration examples to match common use cases #141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gtsiolis merged 1 commit into from
Mar 19, 2026
Merged

Update configuration examples to match common use cases #141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 15 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,15 +93,18 @@ lstk --config /path/to/lstk.toml start

```toml
[[containers]]
Copy link
Copy Markdown
Member

@silv-io silv-io Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we might want to add the update prompt value here. Or I can just add it in my PR depending on what we merge first :D

Copy link
Copy Markdown
Member Author

@gtsiolis gtsiolis Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can update the prompt, merging this one.

type = "aws"
tag = "latest"
port = "4566"
type = "aws" # Emulator type. Currently supported: "aws"
tag = "latest" # Docker image tag, e.g. "latest", "2026.03"
port = "4566" # Host port the emulator will be accessible on
# volume = "" # Host directory for persistent state (default: OS cache dir)
# env = [] # Named environment profiles to apply (see [env.*] sections below)
```

**Fields:**
- `type`: emulator type; only `"aws"` is supported for now
- `tag`: Docker image tag for LocalStack (e.g. `"latest"`, `"4.14.0"`); useful for pinning a version
- `port`: port LocalStack listens on (default `4566`)
- `volume`: (optional) host directory for persistent emulator state (default: OS cache dir)
- `env`: (optional) list of named environment variable groups to inject into the container (see below)

### Passing environment variables to the container
Expand All @@ -111,16 +114,18 @@ Define reusable named env sets and reference them per container:
```toml
[[containers]]
type = "aws"
tag = "4.14.0"
tag = "latest"
port = "4566"
env = ["prod", "debug"]

[env.prod]
LOCALSTACK_HOST = "localstack.cloud"
env = ["debug", "ci"]

[env.debug]
LS_LOG = "trace"
DEBUG = "1"
DEBUG = "1"
ENFORCE_IAM = "1"
PERSISTENCE = "1"

[env.ci]
SERVICES = "s3,sqs"
EAGER_SERVICE_LOADING = "1"
```

## Interactive And Non-Interactive Mode
Expand Down
18 changes: 10 additions & 8 deletions internal/config/default_config.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,22 @@ port = "4566" # Host port the emulator will be accessible on
#
# Example variables based on commonly used current config options:
#
# DEBUG=1 - Enable verbose logging
# PERSISTENCE=1 - Persist LocalStack state across restarts
# ENFORCE_IAM=1 - Enable IAM enforcement
# DEBUG=1 - Enable verbose logging
# PERSISTENCE=1 - Persist LocalStack state across restarts
# ENFORCE_IAM=1 - Enable IAM policy enforcement
# SERVICES=s3,sqs - Limit services to load
# EAGER_SERVICE_LOADING=1 - Preload services at startup
#
# See full list of configuration options:
# > https://docs.localstack.cloud/references/configuration/
#
# Example:
# Example profiles:
#
# [env.debug]
# DEBUG = "1"
#
# [env.persist]
# PERSISTENCE = "1"
#
# [env.security]
# ENFORCE_IAM = "1"
#
# [env.ci]
# SERVICES = "s3,sqs"
# EAGER_SERVICE_LOADING = "1"
Loading