Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phuurl/img-site
Image hosting site for screencaps etc - generates static pages for serverless AWS hosting from image uploads
https://github.com/phuurl/img-site
aws cloudfront go lambda s3 sam serverless
Last synced: 8 days ago
JSON representation
Image hosting site for screencaps etc - generates static pages for serverless AWS hosting from image uploads
- Host: GitHub
- URL: https://github.com/phuurl/img-site
- Owner: Phuurl
- License: mit
- Created: 2022-02-09T23:06:34.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-11T19:34:23.000Z (about 1 year ago)
- Last Synced: 2024-12-29T16:46:08.115Z (12 days ago)
- Topics: aws, cloudfront, go, lambda, s3, sam, serverless
- Language: Go
- Homepage: https://dp97yldgoy09a.cloudfront.net/5c2019ea-7a03-42d0-a750-290651a83222/
- Size: 27.3 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# img-site
The creatively named `img-site` project is a serverless static image hosting site using AWS - you upload images to an input S3 bucket, and static web pages presenting them are generated and served through CloudFront over HTTPS.
Generated pages also include tags to enable media previews on major social networks such as Twitter, Discord, Slack, and anywhere else that supports [OpenGraph](https://ogp.me/).
You can see an example [here](https://dp97yldgoy09a.cloudfront.net/5c2019ea-7a03-42d0-a750-290651a83222/), or see below for more details and deployment instructions.
## Diagram
```
┌────► Uploader ┌───────────────┐ Access ┌────────────┐
│ │ │ │ logs │ │
│ │ │ LoggingBucket │◄─────────┤ CloudFront │◄─────── Viewer
│ │ │ │ │ │
│ │ Image └───────────────┘ └────────────┘
│ │ upload ▲
│ │ │
│ │ │
│ ▼ ▼
│ ┌──────────────┐ ┌────────────────┐ ┌───────────────┐
│ │ │ │ │ │ │
│ │ UploadBucket ├───────►│ IngestFunction ├────────►│ HostingBucket │
│ │ │ │ ├───┐ │ │
│ └──────────────┘ └────────────────┘ │ └───────────────┘
│ Generate HTML └────┐
│ Upload to HostingBucket │
│ Send SNS notification │
│ │
└────────────────────────────────────────────────────┘
SNS email notification with generated link
```
## Parameters
| Parameter | Description | Example |
|----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|
| `UploadBucketName` | Name of the upload S3 bucket to create | `img-bucket-name` |
| `EmailNotificationEnabled` | Whether to enable email notification on image processing completion - `true` or `false` | `true` |
| `NotificationEmail` | Email address to notify on processing completion | `[email protected]` |
| `SiteName` | Name for site - used in HTML template for title | `CoolImages` |
| `NoDomain` | If `true`, a custom domain and certificate is not attached to the CloudFront distribution - useful for testing purposes | `false` |
| `Domain` | Domain name that the image site will be hosted on (ignored if `NoDomain` is `true`) | `img.example.com` |
| `CertArn` | ARN of the ACM certificate to use with the CloudFront distribution (ignored if `NoDomain` is `true`) - note: must be in the `us-east-1` region | `arn:aws:acm:us-east-1:0123456789:certificate/abc-1234-def` |
| `CreateUploadIamUser` | Whether to create an IAM user for upload to the ingest bucket - user created if `true` | `false` |
| `CloudFrontRedirectFunctionName` | Name for the CloudFront redirect function - can leave as default unless you're deploying multiple copies of this stack | `img_site_folder_index_redirect` |
| `CloudFrontCachePolicyName` | Name for the CloudFront cache policy - can leave as default unless you're deploying multiple copies of this stack | `img-site-cache-policy` |
## Deploy
```shell
# Build and deploy SAM stack
sam build --use-container
sam deploy --guided
# Now upload error.html and robots.txt to the deployed HostingBucket
aws s3 cp error.html robots.txt s3:///
```
Once the stack is deployed, you can then add the appropriate DNS (eg Route 53) entries for your domain to point it at the created CloudFront distribution (assuming `NoDomain` is `false`).
You can then upload images to the UploadBucket for processing, and will receive email notifications (assuming `EmailNotificationEnabled` is `true`) once complete with a link to the generated static page on your img-site.