[{"_1":2,"_152":-5,"_153":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_131":132},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":-5,"_85":86,"_124":-5,"_125":11,"_126":17,"_127":11,"_128":-5,"_129":130},"canonicalUrl","https://hub.docker.com/r/tobyhughes/imageproxy/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","tobyhughes","reponame","imageproxy","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":-5,"_57":58,"_59":58,"_60":61,"_62":-5,"_63":64,"_65":66,"_67":11,"_68":29,"_69":70,"_75":17,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2015-07-01T10:40:20.712654Z","description","","is_private","last_updated","2015-07-02T09:24:29.419221Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.distribution.manifest.v1+prettyjws","name","pull_count",271,"repository_type","star_count",1,"status","status_description","active","source","collaborator_count",0,"full_description","# imageproxy [![Build Status](https://travis-ci.org/willnorris/imageproxy.svg?branch=master)](https://travis-ci.org/willnorris/imageproxy) [![GoDoc](https://godoc.org/willnorris.com/go/imageproxy?status.svg)](https://godoc.org/willnorris.com/go/imageproxy) [![Apache 2.0 License](https://img.shields.io/badge/license-Apache%202.0-blue.svg?style=flat)](LICENSE)\n\nimageproxy is a caching image proxy server written in go. It features:\n\n - basic image adjustments like resizing, cropping, and rotation\n - access control using host whitelists or request signing (HMAC-SHA256)\n - support for jpeg, png, and gif image formats (including animated gifs)\n - on-disk caching, respecting the cache headers of the original images\n - easy deployment, since it's pure go\n\nPersonally, I use it primarily to dynamically resize images hosted on my own\nsite (read more in [this post][]). But you can also enable request signing and\nuse it as an SSL proxy for remote images, similar to [atmos/camo][] but with\nadditional image adjustment options.\n\n[this post]: https://willnorris.com/2014/01/a-self-hosted-alternative-to-jetpacks-photon-service\n[atmos/camo]: https://github.com/atmos/camo\n\n\n## URL Structure ##\n\nimageproxy URLs are of the form `http://localhost/{options}/{remote_url}`.\n\n### Options ###\n\nOptions are specified as a comma delimited list of parameters, which can be\nsupplied in any order. Duplicate parameters overwrite previous values.\n\nThe format is a superset of [resize.ly's options](https://resize.ly/#demo).\n\n#### Size ####\n\nThe size option takes the general form `{width}x{height}`, where width and\nheight are numbers. Integer values greater than 1 are interpreted as exact\npixel values. Floats between 0 and 1 are interpreted as percentages of the\noriginal image size. If either value is omitted or set to 0, it will be\nautomatically set to preserve the aspect ratio based on the other dimension.\nIf a single number is provided (with no \"x\" separator), it will be used for\nboth height and width.\n\n#### Crop Mode ####\n\nDepending on the options specified, an image may be cropped to fit the\nrequested size. In all cases, the original aspect ratio of the image will be\npreserved; imageproxy will never stretch the original image.\n\nWhen no explicit crop mode is specified, the following rules are followed:\n\n - If both width and height values are specified, the image will be scaled to\n fill the space, cropping if necessary to fit the exact dimension.\n\n - If only one of the width or height values is specified, the image will be\n resized to fit the specified dimension, scaling the other dimension as\n needed to maintain the aspect ratio.\n\nIf the `fit` option is specified together with a width and height value, the\nimage will be resized to fit within a containing box of the specified size. As\nalways, the original aspect ratio will be preserved. Specifying the `fit`\noption with only one of either width or height does the same thing as if `fit`\nhad not been specified.\n\n#### Rotate ####\n\nThe `r{degrees}` option will rotate the image the specified number of degrees,\ncounter-clockwise. Valid degrees values are `90`, `180`, and `270`. Images\nare rotated **after** being resized.\n\n#### Flip ####\n\nThe `fv` option will flip the image vertically. The `fh` option will flip the\nimage horizontally. Images are flipped **after** being resized and rotated.\n\n#### Quality ####\n\nThe `q{percentage}` option can be used to specify the output quality (JPEG\nonly). If not specified, the default value of `95` is used.\n\n#### Signature ####\n\nThe `s{signature}` option specifies an optional base64 encoded HMAC used to\nsign the remote URL in the request. The HMAC key used to verify signatures is\nprovided to the imageproxy server on startup.\n\n### Remote URL ###\n\nThe URL of the original image to load is specified as the remainder of the\npath, without any encoding. For example,\n`http://localhost/200/https://willnorris.com/logo.jpg`.\n\nIn order to [optimize caching][], it is recommended that URLs not contain query\nstrings.\n\n[optimize caching]: http://www.stevesouders.com/blog/2008/08/23/revving-filenames-dont-use-querystring/\n\n### Examples ###\n\nThe following live examples demonstrate setting different options on [this\nsource image][small-things], which measures 1024 by 678 pixels.\n\n[small-things]: https://willnorris.com/2013/12/small-things.jpg\n\nOptions | Meaning | Image\n--------|------------------------------------------|------\n200x | 200px wide, proportional height | $\"200x\"$ \n0.15x | 15% original width, proportional height | $\"0.15x\"$ \nx100 | 100px tall, proportional width | $\"x100\"$ \n100x150 | 100 by 150 pixels, cropping as needed | $\"100x150\"$ \n100 | 100px square, cropping as needed | $\"100\"$ \n150,fit | scale to fit 150px square, no cropping | $\"150,fit\"$ \n100,r90 | 100px square, rotated 90 degrees | $\"100,r90\"$ \n100,fv,fh | 100px square, flipped horizontal and vertical | $\"100,fv,fh\"$ \n200x,q60 | 200px wide, proportional height, 60% quality | $\"200x,q60\"$ \n\nTransformation also works on animated gifs. Here is [this source\nimage][material-animation] resized to 200px square and rotated 270 degrees:\n\n[material-animation]: https://willnorris.com/2015/05/material-animations.gif\n\n $\"200,r270\"$ \n\n\n## Getting Started ##\n\nInstall the package using:\n\n go get willnorris.com/go/imageproxy/cmd/imageproxy\n\n(Note that go1.2 and earlier may have trouble fetching the package with `go\nget`).\n\nOnce installed, ensure `$GOPATH/bin` is in your `$PATH`, then run the proxy using:\n\n imageproxy\n\nThis will start the proxy on port 8080, without any caching and with no host\nwhitelist (meaning any remote URL can be proxied). Test this by navigating to\n and\nyou should see a 500px square coder octocat.\n\n### Disk cache ###\n\nBy default, the imageproxy command uses an in-memory cache that will grow\nunbounded. To cache images on disk instead, include the `cacheDir` flag:\n\n imageproxy -cacheDir /tmp/imageproxy\n\nReload the [codercat URL][], and then inspect the contents of\n`/tmp/imageproxy`. There should be two files there, one for the original\nfull-size codercat image, and one for the resized 500px version.\n\n[codercat URL]: http://localhost:8080/500/https://octodex.github.com/images/codercat.jpg\n\n### Host whitelist ###\n\nYou can limit the remote hosts that the proxy will fetch images from using the\n`whitelist` flag. This is useful, for example, for locking the proxy down to\nyour own hosts to prevent others from abusing it. Of course if you want to\nsupport fetching from any host, leave off the whitelist flag. Try it out by\nrunning:\n\n imageproxy -whitelist example.com\n\nReload the [codercat URL][], and you should now get an error message. You can\nspecify multiple hosts as a comma separated list, or prefix a host value with\n`*.` to allow all sub-domains as well.\n\n### Signed Requests ###\n\nInstead of a host whitelist, you can require that requests be signed. This is\nuseful in preventing abuse when you don't have just a static list of hosts you\nwant to allow. Signatures are generated using HMAC-SHA256 against the remote\nURL, and url-safe base64 encoding the result:\n\n base64urlencode(hmac.New(sha256, ).digest())\n\nThe HMAC key is specified using the `signatureKey` flag. If this flag\nbegins with an \"@\", the remainder of the value is interpreted as a file on disk\nwhich contains the HMAC key.\n\nTry it out by running:\n\n imageproxy -signatureKey \"secret key\"\n\nReload the [codercat URL][], and you should see an error message. Now load a\n[signed codercat URL][] and verify that it loads properly.\n\n[signed codercat URL]: http://localhost:8080/500,sXyMwWKIC5JPCtlYOQ2f4yMBTqpjtUsfI67Sp7huXIYY=/https://octodex.github.com/images/codercat.jpg\n\nSome simple code samples for generating signatures in various languages can be\nfound starting in [this comment](https://github.com/willnorris/imageproxy/issues/11#issuecomment-101428470).\n\nIf both a whiltelist and signatureKey are specified, requests can match either.\nIn other words, requests that match one of the whitelisted hosts don't\nnecessarily need to be signed, though they can be.\n\n\nRun `imageproxy -help` for a complete list of flags the command accepts. If\nyou want to use a different caching implementation, it's probably easiest to\njust make a copy of `cmd/imageproxy/main.go` and customize it to fit your\nneeds... it's a very simple command.\n\n### Default Base URL ###\n\nTypically, remote images to be proxied are specified as absolute URLs.\nHowever, if you commonly proxy images from a single source, you can provide a\nbase URL and then specify remote images relative to that base. Try it out by running:\n\n imageproxy -baseURL https://octodex.github.com/\n\nThen load the codercat image, specified as a URL relative to that base:\n. Note that this is not an\neffective method to mask the true source of the images being proxied; it is\ntrivial to discover the base URL being used. Even when a base URL is\nspecified, you can always provide the absolute URL of the image to be proxied.\n\n\n## Deploying ##\n\nYou can build and deploy imageproxy using any standard go toolchain, but here's\nhow I do it.\n\nI use [goxc](https://github.com/laher/goxc) to build and deploy to an Ubuntu\nserver. I have a `$GOPATH/willnorris.com/go/imageproxy/.goxc.local.json` file\nwhich limits builds to 64-bit linux:\n\n``` json\n {\n \"ConfigVersion\": \"0.9\",\n \"BuildConstraints\": \"linux,amd64\"\n }\n```\n\nI then run `goxc` which compiles the static binary and creates a deb package at\n`build/0.2.1/imageproxy_0.2.1_amd64.deb` (or whatever the current version is).\nI copy this file to my server and install it using `sudo dpkg -i\nimageproxy_0.2.1_amd64.deb`, which is installed to `/usr/bin/imageproxy`.\n\nUbuntu uses upstart to manage services, so I copy\n[`etc/imageproxy.conf`](etc/imageproxy.conf) to `/etc/init/imageproxy.conf` on\nmy server and start it using `sudo service imageproxy start`. You will\ncertainly want to modify that upstart script to suit your desired\nconfiguration.\n\n## Docker ##\n\nA docker image is available at [`willnorris/imageproxy`](https://registry.hub.docker.com/u/willnorris/imageproxy/dockerfile/).\n\nYou can run it by\n```\ndocker run -p 8080:8080 willnorris/imageproxy -addr 0.0.0.0:8080\n```\n\n## License ##\n\nimageproxy is copyright Google, but is not an official Google product. It is\navailable under the [Apache 2.0 License](./LICENSE).\n","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",647723098,"orgData","recentTags",[87],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_97":98,"_46":113,"_114":90,"_115":29,"_116":52,"_53":117,"_118":119,"_120":104,"_121":113,"_122":61,"_123":17},"content_type","creator",538,"digest","sha256:3976373a532bbd18d8c874da07d89ec3fa78e05ed387a7adec1105c0cdaec43c","full_size",210876716,"id",471822,"images",[99],{"_100":101,"_91":92,"_102":44,"_103":104,"_105":106,"_107":44,"_108":44,"_109":-5,"_110":111,"_59":61,"_112":-5},"architecture","amd64","features","last_pulled","2026-09-15T21:05:51.821259409Z","last_pushed","2015-07-02T09:24:29Z","os","os_features","os_version","size",210877004,"variant","2015-07-02T09:24:30Z","last_updater","last_updater_username","media_type","latest","repository",243491,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":133,"_140":141,"_129":150,"_151":11},{"_36":134,"_38":135,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":136,"_53":31,"_28":29,"_54":55,"_56":-5,"_57":58,"_59":58,"_60":61,"_62":-5,"_63":64,"_65":66,"_67":11,"_68":29,"_69":137,"_75":17,"_76":139,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":138},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_142":58,"_143":-5,"_144":-5,"_145":146},"count","next","previous","results",[147],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_97":148,"_46":113,"_114":90,"_115":29,"_116":52,"_53":117,"_118":119,"_120":104,"_121":113,"_122":61,"_123":17},[149],{"_100":101,"_91":92,"_102":44,"_103":104,"_105":106,"_107":44,"_108":44,"_109":-5,"_110":111,"_59":61,"_112":-5},[],"canDeleteTags","actionData","errors"]

tobyhughes/imageproxy

Tags for tobyhughes/imageproxy