Infrastructure/imageproxy
0
Fork 0
mirror of https://github.com/willnorris/imageproxy.git synced 2024-12-16 21:56:43 -05:00
Code Issues Activity

README.md: format file

Browse source 
I'm honestly not sure which formatter this is using. Probably something
from the markdown LSP server I'm using. Maybe something built in to
neovim or that ships with LazyVim?
This commit is contained in:
Will Norris 2023-08-02 08:30:38 -07:00
parent 84960fc8a0
commit 9708b430f5
1 changed files with 119 additions and 118 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

79
README.md
View file

@ -29,11 +29,11 @@ You can see the go versions that are tested against in [.github/workflows/tests.
[most recent major go releases]: https://golang.org/doc/devel/release.html [most recent major go releases]: https://golang.org/doc/devel/release.html
[.github/workflows/tests.yml]: ./.github/workflows/tests.yml [.github/workflows/tests.yml]: ./.github/workflows/tests.yml
## URL Structure ## ## URL Structure
imageproxy URLs are of the form `http://localhost/{options}/{remote_url}`. imageproxy URLs are of the form `http://localhost/{options}/{remote_url}`.
### Options ### ### Options
Options are available for cropping, resizing, rotation, flipping, and digital Options are available for cropping, resizing, rotation, flipping, and digital
signatures among a few others. Options for are specified as a comma delimited signatures among a few others. Options for are specified as a comma delimited
@ -43,7 +43,7 @@ overwrite previous values.
See the full list of available options at See the full list of available options at
<https://godoc.org/willnorris.com/go/imageproxy#ParseOptions>. <https://godoc.org/willnorris.com/go/imageproxy#ParseOptions>.
### Remote URL ### ### Remote URL
The URL of the original image to load is specified as the remainder of the The URL of the original image to load is specified as the remainder of the
path, without any encoding. For example, path, without any encoding. For example,
@ -54,34 +54,34 @@ strings.
[optimize caching]: http://www.stevesouders.com/blog/2008/08/23/revving-filenames-dont-use-querystring/ [optimize caching]: http://www.stevesouders.com/blog/2008/08/23/revving-filenames-dont-use-querystring/
### Examples ### ### Examples
The following live examples demonstrate setting different options on [this The following live examples demonstrate setting different options on [this
source image][small-things], which measures 1024 by 678 pixels. source image][small-things], which measures 1024 by 678 pixels.
[small-things]: https://willnorris.com/images/imageproxy/small-things.jpg [small-things]: https://willnorris.com/images/imageproxy/small-things.jpg
Options | Meaning | Image | Options | Meaning | Image |
--------|------------------------------------------|------ | ---------------------- | ---------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
200x | 200px wide, proportional height | <a href="https://willnorris.com/api/imageproxy/200x/https://willnorris.com/images/imageproxy/small-things.jpg"><img src="https://willnorris.com/api/imageproxy/200x/https://willnorris.com/images/imageproxy/small-things.jpg" alt="200x"></a> | 200x | 200px wide, proportional height | <a href="https://willnorris.com/api/imageproxy/200x/https://willnorris.com/images/imageproxy/small-things.jpg"><img src="https://willnorris.com/api/imageproxy/200x/https://willnorris.com/images/imageproxy/small-things.jpg" alt="200x"></a> |
x0.15 | 15% original height, proportional width | <a href="https://willnorris.com/api/imageproxy/x0.15/https://willnorris.com/images/imageproxy/small-things.jpg"><img src="https://willnorris.com/api/imageproxy/x0.15/https://willnorris.com/images/imageproxy/small-things.jpg" alt="x0.15"></a> | x0.15 | 15% original height, proportional width | <a href="https://willnorris.com/api/imageproxy/x0.15/https://willnorris.com/images/imageproxy/small-things.jpg"><img src="https://willnorris.com/api/imageproxy/x0.15/https://willnorris.com/images/imageproxy/small-things.jpg" alt="x0.15"></a> |
100x150 | 100 by 150 pixels, cropping as needed | <a href="https://willnorris.com/api/imageproxy/100x150/https://willnorris.com/images/imageproxy/small-things.jpg"><img src="https://willnorris.com/api/imageproxy/100x150/https://willnorris.com/images/imageproxy/small-things.jpg" alt="100x150"></a> | 100x150 | 100 by 150 pixels, cropping as needed | <a href="https://willnorris.com/api/imageproxy/100x150/https://willnorris.com/images/imageproxy/small-things.jpg"><img src="https://willnorris.com/api/imageproxy/100x150/https://willnorris.com/images/imageproxy/small-things.jpg" alt="100x150"></a> |
100 | 100px square, cropping as needed | <a href="https://willnorris.com/api/imageproxy/100/https://willnorris.com/images/imageproxy/small-things.jpg"><img src="https://willnorris.com/api/imageproxy/100/https://willnorris.com/images/imageproxy/small-things.jpg" alt="100"></a> | 100 | 100px square, cropping as needed | <a href="https://willnorris.com/api/imageproxy/100/https://willnorris.com/images/imageproxy/small-things.jpg"><img src="https://willnorris.com/api/imageproxy/100/https://willnorris.com/images/imageproxy/small-things.jpg" alt="100"></a> |
150,fit | scale to fit 150px square, no cropping | <a href="https://willnorris.com/api/imageproxy/150,fit/https://willnorris.com/images/imageproxy/small-things.jpg"><img src="https://willnorris.com/api/imageproxy/150,fit/https://willnorris.com/images/imageproxy/small-things.jpg" alt="150,fit"></a> | 150,fit | scale to fit 150px square, no cropping | <a href="https://willnorris.com/api/imageproxy/150,fit/https://willnorris.com/images/imageproxy/small-things.jpg"><img src="https://willnorris.com/api/imageproxy/150,fit/https://willnorris.com/images/imageproxy/small-things.jpg" alt="150,fit"></a> |
100,r90 | 100px square, rotated 90 degrees | <a href="https://willnorris.com/api/imageproxy/100,r90/https://willnorris.com/images/imageproxy/small-things.jpg"><img src="https://willnorris.com/api/imageproxy/100,r90/https://willnorris.com/images/imageproxy/small-things.jpg" alt="100,r90"></a> | 100,r90 | 100px square, rotated 90 degrees | <a href="https://willnorris.com/api/imageproxy/100,r90/https://willnorris.com/images/imageproxy/small-things.jpg"><img src="https://willnorris.com/api/imageproxy/100,r90/https://willnorris.com/images/imageproxy/small-things.jpg" alt="100,r90"></a> |
100,fv,fh | 100px square, flipped horizontal and vertical | <a href="https://willnorris.com/api/imageproxy/100,fv,fh/https://willnorris.com/images/imageproxy/small-things.jpg"><img src="https://willnorris.com/api/imageproxy/100,fv,fh/https://willnorris.com/images/imageproxy/small-things.jpg" alt="100,fv,fh"></a> | 100,fv,fh | 100px square, flipped horizontal and vertical | <a href="https://willnorris.com/api/imageproxy/100,fv,fh/https://willnorris.com/images/imageproxy/small-things.jpg"><img src="https://willnorris.com/api/imageproxy/100,fv,fh/https://willnorris.com/images/imageproxy/small-things.jpg" alt="100,fv,fh"></a> |
200x,q60 | 200px wide, proportional height, 60% quality | <a href="https://willnorris.com/api/imageproxy/200x,q60/https://willnorris.com/images/imageproxy/small-things.jpg"><img src="https://willnorris.com/api/imageproxy/200x,q60/https://willnorris.com/images/imageproxy/small-things.jpg" alt="200x,q60"></a> | 200x,q60 | 200px wide, proportional height, 60% quality | <a href="https://willnorris.com/api/imageproxy/200x,q60/https://willnorris.com/images/imageproxy/small-things.jpg"><img src="https://willnorris.com/api/imageproxy/200x,q60/https://willnorris.com/images/imageproxy/small-things.jpg" alt="200x,q60"></a> |
200x,png | 200px wide, converted to PNG format | <a href="https://willnorris.com/api/imageproxy/200x,png/https://willnorris.com/images/imageproxy/small-things.jpg"><img src="https://willnorris.com/api/imageproxy/200x,png/https://willnorris.com/images/imageproxy/small-things.jpg" alt="200x,png"></a> | 200x,png | 200px wide, converted to PNG format | <a href="https://willnorris.com/api/imageproxy/200x,png/https://willnorris.com/images/imageproxy/small-things.jpg"><img src="https://willnorris.com/api/imageproxy/200x,png/https://willnorris.com/images/imageproxy/small-things.jpg" alt="200x,png"></a> |
cx175,cw400,ch300,100x | crop to 400x300px starting at (175,0), scale to 100px wide | <a href="https://willnorris.com/api/imageproxy/cx175,cw400,ch300,100x/https://willnorris.com/images/imageproxy/small-things.jpg"><img src="https://willnorris.com/api/imageproxy/cx175,cw400,ch300,100x/https://willnorris.com/images/imageproxy/small-things.jpg" alt="cx175,cw400,ch300,100x"></a> | cx175,cw400,ch300,100x | crop to 400x300px starting at (175,0), scale to 100px wide | <a href="https://willnorris.com/api/imageproxy/cx175,cw400,ch300,100x/https://willnorris.com/images/imageproxy/small-things.jpg"><img src="https://willnorris.com/api/imageproxy/cx175,cw400,ch300,100x/https://willnorris.com/images/imageproxy/small-things.jpg" alt="cx175,cw400,ch300,100x"></a> |
The [smart crop feature](https://godoc.org/willnorris.com/go/imageproxy#hdr-Smart_Crop) The [smart crop feature](https://godoc.org/willnorris.com/go/imageproxy#hdr-Smart_Crop)
can best be seen by comparing crops of [this source image][judah-sheets], with can best be seen by comparing crops of [this source image][judah-sheets], with
and without smart crop enabled. and without smart crop enabled.
Options | Meaning | Image | Options | Meaning | Image |
--------|------------------------------------------|------ | ---------- | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
150x300 | 150x300px, standard crop | <a href="https://willnorris.com/api/imageproxy/150x300/https://judahnorris.com/images/judah-sheets.jpg"><img src="https://willnorris.com/api/imageproxy/150x300/https://judahnorris.com/images/judah-sheets.jpg" alt="200x400,sc"></a> | 150x300 | 150x300px, standard crop | <a href="https://willnorris.com/api/imageproxy/150x300/https://judahnorris.com/images/judah-sheets.jpg"><img src="https://willnorris.com/api/imageproxy/150x300/https://judahnorris.com/images/judah-sheets.jpg" alt="200x400,sc"></a> |
150x300,sc | 150x300px, smart crop | <a href="https://willnorris.com/api/imageproxy/150x300,sc/https://judahnorris.com/images/judah-sheets.jpg"><img src="https://willnorris.com/api/imageproxy/150x300,sc/https://judahnorris.com/images/judah-sheets.jpg" alt="200x400"></a> | 150x300,sc | 150x300px, smart crop | <a href="https://willnorris.com/api/imageproxy/150x300,sc/https://judahnorris.com/images/judah-sheets.jpg"><img src="https://willnorris.com/api/imageproxy/150x300,sc/https://judahnorris.com/images/judah-sheets.jpg" alt="200x400"></a> |
[judah-sheets]: https://judahnorris.com/images/judah-sheets.jpg [judah-sheets]: https://judahnorris.com/images/judah-sheets.jpg
@ -92,7 +92,7 @@ image][material-animation] resized to 200px square and rotated 270 degrees:
<a href="https://willnorris.com/api/imageproxy/200,r270/https://willnorris.com/images/imageproxy/material-animations.gif"><img src="https://willnorris.com/api/imageproxy/200,r270/https://willnorris.com/images/imageproxy/material-animations.gif" alt="200,r270"></a> <a href="https://willnorris.com/api/imageproxy/200,r270/https://willnorris.com/images/imageproxy/material-animations.gif"><img src="https://willnorris.com/api/imageproxy/200,r270/https://willnorris.com/images/imageproxy/material-animations.gif" alt="200,r270"></a>
## Getting Started ## ## Getting Started
Install the package using: Install the package using:
@ -108,7 +108,7 @@ host list (meaning any remote URL can be proxied). Test this by navigating to
<http://localhost:8080/500/https://octodex.github.com/images/codercat.jpg> and <http://localhost:8080/500/https://octodex.github.com/images/codercat.jpg> and
you should see a 500px square coder octocat. you should see a 500px square coder octocat.
### Cache ### ### Cache
By default, the imageproxy command does not cache responses, but caching can be By default, the imageproxy command does not cache responses, but caching can be
enabled using the `-cache` flag. It supports the following values: enabled using the `-cache` flag. It supports the following values:
@ -131,6 +131,7 @@ enabled using the `-cache` flag. It supports the following values:
Additional configuration options ([further documented here][aws-options]) Additional configuration options ([further documented here][aws-options])
may be specified as URL query string parameters, which are mostly useful may be specified as URL query string parameters, which are mostly useful
when working with s3-compatible services: when working with s3-compatible services:
- "endpoint" - specify an alternate API endpoint - "endpoint" - specify an alternate API endpoint
- "disableSSL" - set to "1" to disable SSL when calling the API - "disableSSL" - set to "1" to disable SSL when calling the API
- "s3ForcePathStyle" - set to "1" to force the request to use path-style addressing - "s3ForcePathStyle" - set to "1" to force the request to use path-style addressing
@ -181,7 +182,7 @@ first check an in-memory cache for an image, followed by a gcs bucket:
[tiered fashion]: https://godoc.org/github.com/die-net/lrucache/twotier [tiered fashion]: https://godoc.org/github.com/die-net/lrucache/twotier
### Allowed Referrer List ### ### Allowed Referrer List
You can limit images to only be accessible for certain hosts in the HTTP You can limit images to only be accessible for certain hosts in the HTTP
referrer header, which can help prevent others from hotlinking to images. It can referrer header, which can help prevent others from hotlinking to images. It can
@ -189,12 +190,11 @@ be enabled by running:
imageproxy -referrers example.com imageproxy -referrers example.com
Reload the [codercat URL][], and you should now get an error message. You can Reload the [codercat URL][], and you should now get an error message. You can
specify multiple hosts as a comma separated list, or prefix a host value with specify multiple hosts as a comma separated list, or prefix a host value with
`*.` to allow all sub-domains as well. `*.` to allow all sub-domains as well.
### Allowed and Denied Hosts List ### ### Allowed and Denied Hosts List
You can limit the remote hosts that the proxy will fetch images from using the You can limit the remote hosts that the proxy will fetch images from using the
`allowHosts` and `denyHosts` flags. This is useful, for example, for locking `allowHosts` and `denyHosts` flags. This is useful, for example, for locking
@ -219,7 +219,7 @@ blocking reserved ranges like `127.0.0.0/8`, `192.168.0.0/16`, etc.
If a host matches both an allowed and denied host, the request will be denied. If a host matches both an allowed and denied host, the request will be denied.
### Allowed Content-Type List ### ### Allowed Content-Type List
You can limit what content types can be proxied by using the `contentTypes` You can limit what content types can be proxied by using the `contentTypes`
flag. By default, this is set to `image/*`, meaning that imageproxy will flag. By default, this is set to `image/*`, meaning that imageproxy will
@ -227,7 +227,7 @@ process any image types. You can specify multiple content types as a comma
separated list, and suffix values with `*` to perform a wildcard match. Set the separated list, and suffix values with `*` to perform a wildcard match. Set the
flag to an empty string to proxy all requests, regardless of content type. flag to an empty string to proxy all requests, regardless of content type.
### Signed Requests ### ### Signed Requests
Instead of an allowed host list, you can require that requests be signed. This Instead of an allowed host list, you can require that requests be signed. This
is useful in preventing abuse when you don't have just a static list of hosts is useful in preventing abuse when you don't have just a static list of hosts
@ -262,7 +262,7 @@ If both a whiltelist and signatureKey are specified, requests can match either.
In other words, requests that match one of the allowed hosts don't necessarily In other words, requests that match one of the allowed hosts don't necessarily
need to be signed, though they can be. need to be signed, though they can be.
### Default Base URL ### ### Default Base URL
Typically, remote images to be proxied are specified as absolute URLs. Typically, remote images to be proxied are specified as absolute URLs.
However, if you commonly proxy images from a single source, you can provide a However, if you commonly proxy images from a single source, you can provide a
@ -277,14 +277,14 @@ effective method to mask the true source of the images being proxied; it is
trivial to discover the base URL being used. Even when a base URL is trivial to discover the base URL being used. Even when a base URL is
specified, you can always provide the absolute URL of the image to be proxied. specified, you can always provide the absolute URL of the image to be proxied.
### Scaling beyond original size ### ### Scaling beyond original size
By default, the imageproxy won't scale images beyond their original size. By default, the imageproxy won't scale images beyond their original size.
However, you can use the `scaleUp` command-line flag to allow this to happen: However, you can use the `scaleUp` command-line flag to allow this to happen:
imageproxy -scaleUp true imageproxy -scaleUp true
### WebP and TIFF support ### ### WebP and TIFF support
Imageproxy can proxy remote webp images, but they will be served in either jpeg Imageproxy can proxy remote webp images, but they will be served in either jpeg
or png format (this is because the golang webp library only supports webp or png format (this is because the golang webp library only supports webp
@ -298,20 +298,19 @@ default if any transformation is requested. To force encoding as tiff, pass the
"tiff" option. Like webp, tiff images will be served as-is without any format "tiff" option. Like webp, tiff images will be served as-is without any format
conversion if no transformation is requested. conversion if no transformation is requested.
Run `imageproxy -help` for a complete list of flags the command accepts. If Run `imageproxy -help` for a complete list of flags the command accepts. If
you want to use a different caching implementation, it's probably easiest to you want to use a different caching implementation, it's probably easiest to
just make a copy of `cmd/imageproxy/main.go` and customize it to fit your just make a copy of `cmd/imageproxy/main.go` and customize it to fit your
needs... it's a very simple command. needs... it's a very simple command.
### Environment Variables ### ### Environment Variables
All configuration flags have equivalent environment variables of the form All configuration flags have equivalent environment variables of the form
`IMAGEPROXY_$NAME`. For example, an on-disk cache could be configured by calling `IMAGEPROXY_$NAME`. For example, an on-disk cache could be configured by calling
IMAGEPROXY_CACHE="/tmp/imageproxy" imageproxy IMAGEPROXY_CACHE="/tmp/imageproxy" imageproxy
## Deploying ## ## Deploying
In most cases, you can follow the normal procedure for building a deploying any In most cases, you can follow the normal procedure for building a deploying any
go application. For example: go application. For example:
@ -324,23 +323,24 @@ go application. For example:
Instructions have been contributed below for running on other platforms, but I Instructions have been contributed below for running on other platforms, but I
don't have much experience with them personally. don't have much experience with them personally.
### Heroku ### ### Heroku
It's easy to vendorize the dependencies with `Godep` and deploy to Heroku. Take It's easy to vendorize the dependencies with `Godep` and deploy to Heroku. Take
a look at [this GitHub repo](https://github.com/oreillymedia/prototype-imageproxy/tree/heroku) a look at [this GitHub repo](https://github.com/oreillymedia/prototype-imageproxy/tree/heroku)
(make sure you use the `heroku` branch). (make sure you use the `heroku` branch).
### AWS Elastic Beanstalk ### ### AWS Elastic Beanstalk
[O’Reilly Media](https://github.com/oreillymedia) set up [a repository](https://github.com/oreillymedia/prototype-imageproxy) [O’Reilly Media](https://github.com/oreillymedia) set up [a repository](https://github.com/oreillymedia/prototype-imageproxy)
with everything you need to deploy imageproxy to Elastic Beanstalk. Just follow the instructions with everything you need to deploy imageproxy to Elastic Beanstalk. Just follow the instructions
in the [README](https://github.com/oreillymedia/prototype-imageproxy/blob/master/Readme.md). in the [README](https://github.com/oreillymedia/prototype-imageproxy/blob/master/Readme.md).
### Docker ### ### Docker
A docker image is available at [`ghcr.io/willnorris/imageproxy`](https://github.com/willnorris/imageproxy/pkgs/container/imageproxy). A docker image is available at [`ghcr.io/willnorris/imageproxy`](https://github.com/willnorris/imageproxy/pkgs/container/imageproxy).
You can run it by You can run it by
``` ```
docker run -p 8080:8080 ghcr.io/willnorris/imageproxy -addr 0.0.0.0:8080 docker run -p 8080:8080 ghcr.io/willnorris/imageproxy -addr 0.0.0.0:8080
``` ```
@ -360,7 +360,7 @@ Note that all configuration options can be set using [environment
variables](#environment-variables), which is often the preferred approach for variables](#environment-variables), which is often the preferred approach for
containers. containers.
### nginx ### ### nginx
Use the `proxy_pass` directive to send requests to your imageproxy instance. Use the `proxy_pass` directive to send requests to your imageproxy instance.
For example, to run imageproxy at the path "/api/imageproxy/", set: For example, to run imageproxy at the path "/api/imageproxy/", set:
@ -380,10 +380,11 @@ to alter the precedence order by setting:
} }
``` ```
## Clients ## ## Clients
- [Ruby](https://github.com/azolf/imageproxy_ruby) - [Ruby](https://github.com/azolf/imageproxy_ruby)
## License ## ## License
imageproxy is copyright its respective authors. All of my personal work on imageproxy is copyright its respective authors. All of my personal work on
imageproxy through 2020 (which accounts for the majority of the code) is imageproxy through 2020 (which accounts for the majority of the code) is