# StackPort

> StackPort is an open-source (MIT) web console for local AWS emulators and real AWS accounts. It connects to MiniStack, Floci, LocalStack, Moto, or any AWS-compatible endpoint over the standard AWS API and lets you browse, inspect, and manage resources across 35 AWS services.

Key facts:

- Install with `pip install stackport` (Python 3.10+) and run `stackport`, or run the Docker image `davireis/stackport`. The UI is served on http://localhost:8080.
- Point it at an emulator with `AWS_ENDPOINT_URL`, for example `AWS_ENDPOINT_URL=http://localhost:4566 stackport`. When it is unset, StackPort uses real AWS through the standard credential chain. Several endpoints, each with its own region and credentials, can be configured at once.
- StackPort is not an emulator. It does not emulate AWS itself; it is a client that talks to an emulator or to AWS with boto3. Nothing is installed inside the emulator.
- Supported emulators are documented side by side: MiniStack, Floci, LocalStack, Moto. No emulator is preferred. Any other endpoint that speaks the AWS API also works.
- 13 services have dedicated views (S3, DynamoDB, Lambda, SQS, SNS, IAM, EC2, RDS, CloudWatch Logs, CloudWatch metrics and alarms, Secrets Manager, KMS, Step Functions). The remaining services get a generic, searchable resource table.
- Writes (S3 uploads, DynamoDB item edits, SQS messages, SNS publishes, and others) are on by default, including against real AWS. `STACKPORT_ALLOW_WRITES=false` turns on read-only mode, in which the server refuses every write (Lambda Invoke stays available).
- Also included: guided lessons that check real resource state, tag editing, JSON/CSV export, and a CLI (`serve`, `status`, `list`, `describe`, `export`).
- Backend: Python, FastAPI, boto3. Frontend: React with the Cloudscape Design System.
- StackPort is a community project and is not affiliated with Amazon Web Services or with any of the emulator projects.

Every page listed below is plain Markdown. The same page in HTML lives at the same path without `.md` and with a trailing slash.

## Full documentation

- [llms-full.txt](https://stackport.cloud/llms-full.txt): every page below in one Markdown file

## Getting started

- [Introduction](https://stackport.cloud/docs/introduction.md): StackPort is an open-source web console for local AWS emulators and real AWS accounts. What it does, how it is built, and where to start.
- [Installation](https://stackport.cloud/docs/installation.md): Install StackPort with pip, run the Docker image, or start it next to an emulator with Docker Compose.
- [Quick Start](https://stackport.cloud/docs/quickstart.md): Start StackPort next to MiniStack, Floci, LocalStack or Moto, create a few resources, and browse them in under a minute.

## Emulator guides

- [Using StackPort with MiniStack](https://stackport.cloud/docs/guides/ministack.md): Run StackPort as a web console for MiniStack. Setup, a Docker Compose file, what works, and tips for browsing MiniStack resources in a UI.
- [Using StackPort with Floci](https://stackport.cloud/docs/guides/floci.md): Run StackPort as a web console for Floci. Setup, a Docker Compose file, what works, and tips for browsing Floci resources in a UI.
- [Using StackPort with LocalStack](https://stackport.cloud/docs/guides/localstack.md): Run StackPort as a web console for LocalStack. Setup, a Docker Compose file, what works, and tips for browsing LocalStack resources in a UI.
- [Using StackPort with Moto](https://stackport.cloud/docs/guides/moto.md): Run StackPort as a web console for Moto. Setup, a Docker Compose file, what works, and tips for browsing Moto resources in a UI.
- [Browse local S3 and DynamoDB in a web UI](https://stackport.cloud/docs/guides/local-s3-dynamodb.md): Use StackPort as a GUI for local S3 and DynamoDB, including DynamoDB Local and MinIO. Browse tables and buckets, edit items, upload files, no AWS console needed.

## Configuration

- [Environment Variables](https://stackport.cloud/docs/configuration/environment-variables.md): Every StackPort setting, from the AWS endpoint and region to read-only mode, Learn, probing and the data directory.
- [Docker](https://stackport.cloud/docs/configuration/docker.md): Run the StackPort Docker image on its own or in Docker Compose, with networking, health checks, AWS profiles and persistent settings.
- [Emulators](https://stackport.cloud/docs/configuration/emulators.md): StackPort works with MiniStack, Floci, LocalStack, Moto and any other AWS-compatible endpoint. How to connect each one.
- [Multiple Endpoints and Authentication](https://stackport.cloud/docs/configuration/endpoints.md): Connect StackPort to several emulators and AWS accounts at once, each with its own region and credentials (default chain, AWS profile with SSO or AssumeRole, or static keys).
- [Real AWS and Read-only Mode](https://stackport.cloud/docs/configuration/real-aws.md): Browse a real AWS account with StackPort using profiles, SSO or keys, and turn on read-only mode so every write is refused by the server.

## Service views

- [Service Browsers](https://stackport.cloud/docs/services/overview.md): StackPort's 13 dedicated service views and the generic resource table for the other 22 AWS services, with the write operations each one supports.
- [S3 Browser](https://stackport.cloud/docs/services/s3.md): Browse S3 buckets and objects in a web UI for local emulators or real AWS. Upload by drag and drop, download, manage folders, tags, versioning, lifecycle, CORS and event notifications.
- [DynamoDB Browser](https://stackport.cloud/docs/services/dynamodb.md): A web UI for DynamoDB tables on local emulators and DynamoDB Local. Scan and query items, create tables, and create, edit or delete items as plain JSON or DynamoDB JSON.
- [Lambda Browser](https://stackport.cloud/docs/services/lambda.md): Inspect Lambda functions on local emulators or AWS, invoke them with event templates, edit memory, timeout and environment variables, and download the code package.
- [SQS Browser](https://stackport.cloud/docs/services/sqs.md): Manage SQS queues in a web UI. Create Standard or FIFO queues with a dead-letter queue, send single or batch messages, poll, delete, purge, and keep saved messages for testing.
- [SNS Browser](https://stackport.cloud/docs/services/sns.md): Browse SNS topics and subscriptions in a web UI. Create Standard or FIFO topics, publish messages with attributes, subscribe SQS queues, Lambda functions, HTTP endpoints or email, and inspect filter policies.
- [EC2 Browser](https://stackport.cloud/docs/services/ec2.md): Browse EC2 instances, security group rules, VPCs, subnets and Auto Scaling groups, and start, stop, reboot or terminate instances from a web UI.
- [IAM Browser](https://stackport.cloud/docs/services/iam.md): A read-only web view of IAM users, groups, roles and customer-managed policies, with trust policies, attached and inline policies, access keys and policy documents.
- [RDS Browser](https://stackport.cloud/docs/services/rds.md): A read-only web view of RDS DB instances, Aurora clusters, snapshots and parameter groups, with copyable connection endpoints for local emulators or AWS.
- [KMS Browser](https://stackport.cloud/docs/services/kms.md): A read-only web view of AWS KMS keys with their key policies, grants, aliases and rotation settings, for local emulators or real AWS.
- [Step Functions Browser](https://stackport.cloud/docs/services/step-functions.md): Visualize Step Functions state machines as a graph, start and stop executions, and follow each run on an execution path overlay and a per-state timeline.
- [CloudWatch Logs Browser](https://stackport.cloud/docs/services/cloudwatch-logs.md): Browse CloudWatch log groups, streams and events in a web UI, filter with CloudWatch patterns and time ranges, and tail logs live from your local emulator.
- [CloudWatch Metrics Browser](https://stackport.cloud/docs/services/cloudwatch-metrics.md): View CloudWatch dashboards as live metric charts and inspect CloudWatch alarms, their state, thresholds and reasons, in a read-only web UI.
- [Secrets Manager Browser](https://stackport.cloud/docs/services/secrets-manager.md): Browse and manage Secrets Manager secrets in a web UI. Reveal and copy values, edit them as text or JSON, duplicate, schedule deletion and restore.

## Guided lessons

- [Guided lessons](https://stackport.cloud/docs/learn/guided-lessons.md): Learn AWS hands-on without an AWS account or a bill. StackPort's guided lessons run inside the console against your local emulator and check your real resources as you go.

## CLI

- [CLI Commands](https://stackport.cloud/docs/cli/commands.md): StackPort CLI reference for serve, status, list, describe and export, with output formats and endpoint flags for scripts and CI.

## Optional

- [GitHub repository](https://github.com/DaviReisVieira/stackport): source code, README, issues, and CONTRIBUTING
- [PyPI package](https://pypi.org/project/stackport/): release history and supported Python versions
- [Docker image](https://hub.docker.com/r/davireis/stackport): the single-container distribution