Skip to content

feat: support aws s3 image uploads #354

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
rafa-stacks merged 1 commit into from
Jul 9, 2026
Merged

feat: support aws s3 image uploads #354

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
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ fetch off-chain metadata.
* Live tracking of FT/SFT supply through mint and burn event deltas
* Easy to use REST JSON endpoints with ETag caching
* Prometheus metrics for job queue status, contract and token counts, API performance, and more
* Optional image cache/CDN via Google Cloud Storage
* Optional image cache/CDN via Google Cloud Storage or Amazon S3
* Run modes (`default`, `readonly`, `writeonly`) for auto-scaling deployments
* Admin RPC server for operational tasks (retry failed jobs, refresh metadata, import contracts)

Expand Down Expand Up @@ -76,7 +76,7 @@ See the [client README](./client/README.md) or the
| **PostgreSQL** | >= 15 (local, writable) |
| **Stacks node** | Fully synchronized, with the RPC interface accessible |
| **Redis** | Required for the SNP event stream (`SNP_REDIS_URL`) |
| **Google Cloud Storage** | *(Optional)* For token image caching |
| **Cloud object storage** | *(Optional)* Google Cloud Storage or Amazon S3 for token image caching |

### Running the service

Expand Down Expand Up @@ -215,9 +215,13 @@ All configuration is done via environment variables. Defaults are shown in paren
| Variable | Description | Default |
|---|---|---|
| `IMAGE_CACHE_PROCESSOR_ENABLED` | Enable image caching | `false` |
| `IMAGE_CACHE_UPLOAD_PROVIDER` | Image upload backend (`gcs` or `aws`) | `gcs` |
| `IMAGE_CACHE_RESIZE_WIDTH` | Thumbnail width (px) | `300` |
| `IMAGE_CACHE_GCS_BUCKET_NAME` | Google Cloud Storage bucket name | *(none)* |
| `IMAGE_CACHE_GCS_OBJECT_NAME_PREFIX` | Object name prefix in GCS | *(none)* |
| `IMAGE_CACHE_AWS_BUCKET_NAME` | Amazon S3 bucket name | *(none)* |
| `IMAGE_CACHE_AWS_REGION` | AWS region for S3 uploads | *(none)* |
| `IMAGE_CACHE_AWS_OBJECT_NAME_PREFIX` | Object name prefix in S3 | *(none)* |
| `IMAGE_CACHE_CDN_BASE_PATH` | CDN base URL for cached images | *(none)* |
| `IMAGE_CACHE_MAX_BYTE_SIZE` | Max image size to cache (bytes) | *(none)* |

Expand Down
Loading
Loading