Files
storage/CLAUDE.md
T

44 lines
1.4 KiB
Markdown
Raw Normal View History

# storage
2026-01-08 14:09:14 +01:00
Standalone Go library for AWS S3 storage operations.
2026-01-08 14:09:14 +01:00
**Note:** This is an independent library, not part of the Shiny ecosystem, though it is currently only used by Shiny services.
2026-01-08 14:09:14 +01:00
## Purpose
Provides standardized S3 object storage utilities with presigned URL generation. Used by services that need to store and serve files (PDFs, images, etc.).
2026-01-08 14:09:14 +01:00
## Usage
```go
import "gitea.unbound.se/unboundsoftware/storage"
2026-01-08 14:09:14 +01:00
// Option 1: Managed uploads (multipart, 5MB part size) - loads AWS config automatically
s3Storage, err := storage.New("my-bucket")
2026-01-08 14:09:14 +01:00
// Option 2: Direct uploads with custom AWS config
cfg, _ := config.LoadDefaultConfig(context.Background())
s3Storage := storage.NewS3(cfg, "my-bucket")
// Upload and get presigned URL (15-minute expiration)
url, err := s3Storage.Store("path/to/file.pdf", reader, "application/pdf")
```
2026-01-08 14:09:14 +01:00
## Features
2026-01-08 14:09:14 +01:00
- **Managed uploads** (`New`) - Uses upload manager with 5MB multipart chunks for large files
- **Direct uploads** (`NewS3`) - Uses PutObject directly, allows custom AWS config
- **Presigned URLs** - 15-minute expiration for secure access
2026-01-08 14:09:14 +01:00
## Configuration
Uses AWS SDK v2, loading config from:
- Environment variables (`AWS_REGION`, `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`)
- Shared config files (`~/.aws/config`, `~/.aws/credentials`)
- IAM roles (on AWS infrastructure)
2026-01-08 14:09:14 +01:00
## Development
- Go 1.23+
- Run tests: `go test ./...`