Quick Start
Get ZapFS running in minutes with Docker Compose or Kubernetes.
Docker Compose (Development)
The fastest way to try ZapFS locally:
# Clone the repository
git clone https://github.com/LeeDigitalWorks/zapfs.git
cd zapfs/docker
# Start the cluster
docker compose up -d
# Test with AWS CLI
aws --endpoint-url=http://localhost:8082 s3 mb s3://test-bucket
aws --endpoint-url=http://localhost:8082 s3 cp README.md s3://test-bucket/
aws --endpoint-url=http://localhost:8082 s3 ls s3://test-bucket/Kubernetes (Helm)
For production deployments, use the Helm chart:
cd k8s/zapfs
helm dependency update
helm install zapfs . -n zapfs --create-namespaceDefault Credentials
The development cluster uses these default IAM credentials:
| Key | Value |
|---|---|
| Access Key | AKIAIOSFODNN7EXAMPLE |
| Secret Key | wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY |
Warning: Change these credentials in production. See the IAM documentation for details.
Configure AWS CLI
Set up the AWS CLI to work with your ZapFS cluster:
# Configure a named profile for ZapFS
aws configure --profile zapfs
# Enter when prompted:
# AWS Access Key ID: AKIAIOSFODNN7EXAMPLE
# AWS Secret Access Key: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
# Default region name: us-east-1
# Default output format: json
# Use the profile with --endpoint-url
aws --profile zapfs --endpoint-url=http://localhost:8082 s3 lsVerify Installation
Check that all services are running:
# Check container status
docker compose ps
# View logs
docker compose logs -f
# Check manager health
curl http://localhost:8060/health
# Check metadata service health
curl http://localhost:8082/health