Getting Started

Prerequisites

• Docker and Docker Compose
• AWS CLI (optional, for command line testing)

1. Setup AWS Credentials

Create a mock AWS credentials profile in ~/.aws/credentials:

[mock]
aws_access_key_id = mock1234
aws_secret_access_key = mock1234

2. Start Services

Start all services:

docker compose up -d

Or start specific services:

# Just S3 and DynamoDB
docker compose up -d s3 dynamodb

# Just the inspector console
docker compose up -d console

3. Use with AWS CLI

# Set your profile
export AWS_PROFILE=mock

# Create an S3 bucket
aws --endpoint=http://localhost:9000 s3 mb s3://test-bucket

# Create a DynamoDB table
aws --endpoint=http://localhost:8000 dynamodb list-tables

# Create an SQS queue
aws --endpoint=http://localhost:9324 sqs create-queue --queue-name test

4. Use with AWS SDK

// JavaScript example
const AWS = require('aws-sdk');

const s3 = new AWS.S3({
    endpoint: 'http://localhost:9000',
    accessKeyId: 'mock1234',
    secretAccessKey: 'mock1234',
    s3ForcePathStyle: true,
});

const buckets = await s3.listBuckets().promise();

5. Inspector Console

The FakeWS Inspector Console provides a web UI to browse your services. Start it with:

docker compose up -d console

Then visit http://localhost:3000

Port Reference

Service	Port
S3 (MinIO API)	9000
S3 Console	9090
DynamoDB	8000
SQS	9324
SNS	9911
IAM	5050
Cognito	9229
SSM	9230
CloudWatch	5051
CloudWatch Logs	5052
Inspector Console	3000
Console API	3001