photos
/
photos
1
0
Fork 0
Code Issues 7 Releases Activity
34 Commits
1 Branch
0 Tags
599 KiB
Go 56.9%
JavaScript 21.1%
Svelte 7.7%
CSS 4%
HTML 3.1%
Other 7.2%
 
 
 
 
 
 
Go to file
Ambrose Chua 32d5b985b4 Add Tilt 2021-11-17 18:37:38 +08:00
build Add Tilt 2021-11-17 18:37:38 +08:00
cmd Add Tilt 2021-11-17 18:37:38 +08:00
deployments Add Tilt 2021-11-17 18:37:38 +08:00
internal/httphelpers Get web interface into working state 2020-08-23 00:21:56 +08:00
pkg Get web interface into working state 2020-08-23 00:21:56 +08:00
web Add Tilt 2021-11-17 18:37:38 +08:00
.dockerignore Add Tilt 2021-11-17 18:37:38 +08:00
.gitignore Add Tilt 2021-11-17 18:37:38 +08:00
README.md WIP: new bucket layout with preview 2020-06-14 18:40:55 +08:00
Tiltfile Add Tilt 2021-11-17 18:37:38 +08:00
go.mod Add Tilt 2021-11-17 18:37:38 +08:00
go.sum Get web interface into working state 2020-08-23 00:21:56 +08:00
main.go More planning 2020-05-26 12:45:55 +08:00

README.md

photos

A photo bucket management suite.

Bucket Format

  • photo/[filename]
    • Original photo. Name conflict resolution (excluding extension) must be handled client-side.
  • preview/[filename]_h[height]q[quality].[format]
    • Preview photos at lower resolutions and quality.
    • Generator: preview
  • photometadata/[filename]/size
    • Original photo size, JSON
    • Generator: preview
  • photometadata/[filename]/date
    • Original photo date taken, unix timestamp
    • Generator: preview
  • photometadata/[filename]/title
    • Photo title
  • photometadata/[filename]/tags
    • Photo tags
  • metadata/title
    • Photo album title
  • metadata/description
    • Photo album description, markdown
  • metadata/ordering
    • Manual sort ordering, newline separated
  • internal/control
    • Access control settings, JSON

admin

  • Standalone tool to manage an S3-like account
    • In-browser handling of:
      • ListBuckets
      • MakeBucket
      • RemoveBucket
    • Setup photo bucket
      • Uploads initial metadata
      • SetBucketPolicy that matches
      • Adds credentials to database.
    • Disconnect photo bucket
      • Removes credentials from database

Operations

PUT /credential?bucket=BUCKET

  1. Ensure credentials work on BUCKET
  2. Write credentials to KV store

DELETE /credential?bucket=BUCKET

  1. Ensure credentials work on BUCKET
  2. Write credentials to KV store

Data

Credentials must be passed as:

{
  "access_key": string,
  "secret_key": string,
  "region": string
}

control

Implement access controls by signing requests, using credentials in database.

Operations

GET /sign?bucket=BUCKET&token=TOKEN&request=REQUEST

  1. Consult the bucket for metadata/control with credentials
  2. Get read access method for the bucket
  3. Validate the token against the access method
  4. Validate REQUEST is an acceptable request
  • ListObjectsV2, GetObject
  • Not internal/
  1. If necessary, presign an object URL for 4 days
  • Cache presigned URLs for 2 days in memory/Redis
  1. 307 redirect to presigned URL

PUT /sign?bucket=BUCKET&token=TOKEN&request=REQUEST

  1. Consult the bucket for metadata/control with credentials
  2. Get write access method for the bucket
  3. Validate the token against the access method
  4. Validate REQUEST is an acceptable request
  • PutObject
  • Not internal/
  1. If necessary, presign an object URL for 30 minutes
  2. 307 redirect to presigned URL

DELETE /sign?bucket=BUCKET&token=TOKEN&request=REQUEST

  1. Consult the bucket for metadata/control with credentials
  2. Get write access method for the bucket
  3. Validate the token against the access method
  4. Validate REQUEST is an acceptable request
  • RemoveObject
  • Not internal/
  1. If necessary, presign an object URL for 30 minutes
  2. 307 redirect to presigned URL

Authentication

Token

The read/write token is checked against a simple string defined in the bucket.

OpenID Connect

Recommended IDP: dex

The read/write operation is gated by a signed key corresponding to allowed users defined in the bucket.

web

Generates the web interface for a photo bucket. Also serves up the shared assets.

Operations

POST /update?bucket=BUCKET

Regenerate and upload index.html and manage/index.html to bucket.

preview

Generate previews from photo buckets.

Operations

POST /update?bucket=BUCKET&photo=OBJECT

  1. Perform preview generation using libvips (maybe limit?)
  2. Block until done

proxy

Reverse proxies buckets to the MinIO endpoint, as a substitute for AWS S3 website hosting features. Serves up index.html when URLs end in a slash.

In production, replace this with Nginx.