From c724989f9146d50a90417d6a5787753659aeeef6 Mon Sep 17 00:00:00 2001 From: Ryan McCue Date: Fri, 12 Oct 2018 16:42:35 +1000 Subject: [PATCH] Add design documentation --- docs/README.md | 18 +----------------- docs/design.md | 21 +++++++++++++++++++++ 2 files changed, 22 insertions(+), 17 deletions(-) create mode 100644 docs/design.md diff --git a/docs/README.md b/docs/README.md index e592a1e..705d660 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,23 +2,6 @@ Tachyon is a faster than light image resizing service that runs on AWS. Super simple to set up, highly available and very performant. -Tachyon is built with some strong opinions and assumptions: - -- Runs on AWS (using CloudFront, Lambda and API Gateway.) -- Expects original image files to be stored on Amazon S3. -- Only supports simple image resizing, not a full image manipulation service. - -Tachyon works best with WordPress, coupled with [S3 Uploads](https://github.com/humanmade/s3-uploads) and the [Tachyon Plugin](https://github.com/humanmade/tachyon-plugin). - -Tachyon only supports serving from S3 buckets you own, on servers you're running. For other use cases, consider [Photon][] or [Imgix](https://imgix.com/). - - -## Why Tachyon? - -Tachyon aims at doing one thing well: serving images from S3. It allows resizing those images, cropping, and changing the image quality, but is not intended to be an all-in-one image manipulation server. This keeps the code lightweight and fast. - -Tachyon is entirely self-hosted, and relies on AWS infrastructure. This allows you to manage scale as you need, as well as control the cache. - ## Setup @@ -29,6 +12,7 @@ The server is also available as a [Docker image](docker.md), which can be used i ## Documentation +* [Design](design.md) - Motivation and Design * [Server Setup](server.md) (or, [Docker Setup](docker.md)) * [Plugin Setup](plugin.md) * [Hints and Tips][tips.md] diff --git a/docs/design.md b/docs/design.md new file mode 100644 index 0000000..52fe27b --- /dev/null +++ b/docs/design.md @@ -0,0 +1,21 @@ +# Design + +## Why Tachyon? + +Tachyon aims at doing one thing well: serving images from S3. It allows resizing those images, cropping, and changing the image quality, but is not intended to be an all-in-one image manipulation server. This keeps the code lightweight and fast. + +Tachyon is entirely self-hosted, and relies on AWS infrastructure. This allows you to manage scale as you need, as well as control the cache. + + +## Assumptions + +Tachyon is built with some strong opinions and assumptions: + +- Runs on AWS (using CloudFront, Lambda and API Gateway.) +- Expects original image files to be stored on Amazon S3. +- Only supports simple image resizing, not a full image manipulation service. + + +## Limitations + +Tachyon only supports serving from S3 buckets you own, on servers you're running. For other use cases, consider [Photon](https://developer.wordpress.com/docs/photon/) or [Imgix](https://imgix.com/).