Skip to content

Commit 77eeaa4

Browse files
committed
Update intro
1 parent 568b556 commit 77eeaa4

File tree

16 files changed

+916
-249
lines changed

16 files changed

+916
-249
lines changed

docs/intro.mdx

Lines changed: 70 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -9,52 +9,99 @@ displayed_sidebar: tutorialSidebar
99
<img
1010
alt="imgproxy logo"
1111
src="/img/logo-light.svg"
12-
class="intro__logo intro__logo-light"
12+
class="intro__logo intro__img-light"
1313
/>
1414
<img
1515
alt="imgproxy logo"
1616
src="/img/logo-dark.svg"
17-
class="intro__logo intro__logo-dark"
17+
class="intro__logo intro__img-dark"
1818
/>
1919
</h1>
2020

21-
[imgproxy](https://imgproxy.net) is a fast and secure standalone server for resizing, processing, and converting images. The guiding principles behind imgproxy are security, speed, and simplicity.
21+
[imgproxy](https://imgproxy.net) is a fast and secure standalone server for resizing, processing, and converting images. The guiding principles behind imgproxy are speed, security, and simplicity.
2222

23-
imgproxy is able to quickly and easily resize images on the fly, and it's well-equipped to handle a large amount of image resizing. imgproxy is a fast, secure replacement for all the image resizing code inside your web application (such as resizing libraries, or code that calls ImageMagick or GraphicsMagic). It's also an indispensable tool for processing images from a remote source. With imgproxy, you don’t need to repeatedly prepare images to fit your design every time it changes.
23+
imgproxy is able to quickly and easily resize, process, and optimize images on the fly, and it's well-equipped to handle a large amount of image processing. imgproxy is a drop-in replacement for all the image processing code inside your web application (such as using image processing libraries or calling command-line tools). With imgproxy, you don’t need to repeatedly re-prepare images to fit your design every time it changes, as imgproxy does this on demand.
2424

25-
To get an even better introduction, and to dive deeper into the nitty gritty details, check out this article: [imgproxy: Resize your images instantly and securely](https://evilmartians.com/chronicles/introducing-imgproxy)
25+
To get an even better introduction and to dive deeper into the nitty-gritty details, check out this article by Evil Martians: [imgproxy: Resize your images instantly and securely](https://evilmartians.com/chronicles/introducing-imgproxy)
26+
27+
## Features
28+
29+
imgproxy is packed with features to the brim to cover all your image processing needs:
30+
31+
| Feature | imgproxy OSS | [imgproxy Pro](https://imgproxy.net/#pro) |
32+
|---|---|---|
33+
| Image formats | Basic formats: JPEG, PNG, GIF, WebP, AVIF, JPEG XL, [and more](https://docs.imgproxy.net/image_formats_support) | Preview generation for video, PDF, and Photoshop documents |
34+
| Processing | Resizing, cropping, rotating, watermarking, filters | Getting image info, advanced watermarking, color adjustment |
35+
| Optimization | Color profile and metadata stripping, PNG quantization | Advanced compression settings, GIF to MP4 conversion, SVG minification |
36+
| Smart features | Simple smart cropping, auto-quality by file size | Object detection, advanced smart cropping, auto-quality by SSIM, best format selection |
37+
38+
Check out the [full feature list](https://imgproxy.net/features) for more details.
39+
40+
## How it works
41+
42+
imgproxy works as a standalone HTTP server. You provide it with a source image URL and a set of processing options via a specially crafted URL, and imgproxy fetches the image, processes it according to your specifications, and serves the resulting image back to you. You can use imgproxy URLs directly in your HTML, CSS, or JavaScript code, just like you would with any other image URL.
43+
44+
This way, imgproxy offloads all the image processing work from your application. The only thing your application needs to do is to [generate imgproxy URLs](https://docs.imgproxy.net/usage/processing) with the desired processing options.
45+
46+
<p align="center">
47+
<img
48+
alt="How imgproxy works scheme"
49+
src="/img/how-it-works-light.png"
50+
class="intro__img intro__img-light"
51+
loading='lazy'
52+
decoding='async'
53+
/>
54+
<img
55+
alt="How imgproxy works scheme"
56+
src="/img/how-it-works-dark.png"
57+
class="intro__img intro__img-dark"
58+
loading='lazy'
59+
decoding='async'
60+
/>
61+
</p>
62+
63+
## Main principles
2664

2765
### Simplicity
2866

29-
> "No code is better than no code."
67+
> Keep it simple, stupid!
3068
31-
imgproxy only includes the must-have features for image processing, fine-tuning, and security. Specifically,
69+
We believe that software should be simple yet powerful. If your grandma can't get it up and running, you should make it simpler. That's why we designed imgproxy to be ready to use in a couple of minutes with minimal configuration. Check out the [Getting Started guide](https://docs.imgproxy.net/getting_started) to see how easy it is.
3270

33-
* It would be great to be able to flip images, apply masks, or round corners, but in most cases, it is possible — and is much easier — to do that using CSS.
34-
* It may be great to have built-in HTTP caching of some kind, but it is way better to use a Content-Delivery Network or a caching proxy server for this, as you will have to do this sooner or later in the production environment.
35-
* It might be useful to have everything built in — such as HTTPS support — but, again, an easy way to solve that would be just to use a proxying HTTP server, a load balancer, or a CDN.
71+
> No code is better than no code.
72+
73+
We believe in the single responsibility principle. If something can be done better outside of imgproxy, we won't reinvent the wheel. As a couple of examples:
74+
75+
* HTTPS support sounds like a must-have feature for a web server. However, imgproxy will live behind a CDN, a load balancer, or a reverse proxy in a production environment anyway, so there is no need to implement HTTPS support inside imgproxy itself.
76+
* Rounding image corners or applying masks sounds useful, but doing this with CSS is way easier and more flexible.
3677

3778
### Speed
3879

39-
imgproxy takes advantage of probably the most efficient image processing library out there – `libvips`. It’s scary fast and comes with a very low memory footprint. Thanks to libvips, we can readily and extemporaneously process a massive amount of images.
80+
We strive to tune every little piece of imgproxy to make it as fast as possible.
4081

41-
imgproxy uses Go’s raw (no wrappers) native `net/http` package to omit any overhead while processing requests and provides the best possible HTTP support.
82+
imgproxy takes advantage of probably the most efficient image processing library out there – [libvips](https://github.com/libvips/libvips). It’s scary fast and comes with a very low memory footprint. Our extensive experience with libvips has enabled us to optimize our image-processing pipeline to its maximum.
4283

43-
You can take a look at some benchmarking results and compare imgproxy with some well-known alternatives in our [benchmark report](https://github.com/imgproxy/imgproxy/blob/master/BENCHMARK.md).
84+
You can take a look at some benchmarking results and compare imgproxy with some well-known alternatives in our [benchmark report](https://imgproxy.net/blog/image-processing-servers-benchmark/).
4485

4586
### Security
4687

47-
In terms of security, the massive processing of remote images is a potentially dangerous endeavor. There are a number of possible attack vectors, so it’s a good idea to take an approach that considers attack prevention measures as a priority. Here’s how imgproxy does this:
88+
Image processing is a wide attack surface. That's why we treat security very seriously. imgproxy offers several security measures that enable you to strike the optimal balance between security and usability for your specific use case. For example:
4889

49-
* imgproxy checks the image type and its “real” dimensions when downloading. The image will not be fully downloaded if it has an unknown format or if the dimensions are too big (you can set the max allowed dimensions). This is how imgproxy protects from so-called "image bombs”, like those described in [this doc](https://www.bamsoftware.com/hacks/deflate.html).
90+
* imgproxy supports signing image URLs to prevent abusing your image processing server for denial-of-service attacks or simply using it for the attacker's own needs.
91+
* imgproxy checks the image type before fully downloading it to prevent unwanted resource consumption.
92+
* imgproxy checks the real image dimensions before decoding it to prevent so-called "image bombs", like those described in [this doc](https://www.bamsoftware.com/hacks/deflate.html).
93+
* imgproxy supports authorization by HTTP header to prevent direct access to it, bypassing your CDN or caching server.
94+
* imgproxy allows restricting image sources, maximum image file size, processing options, etc.
5095

51-
* imgproxy protects image URLs with a signature, so an attacker cannot enact a denial-of-service attack by requesting multiple image resizes.
96+
Check out our documentation for more details on [security features](https://docs.imgproxy.net/configuration/options#security).
5297

53-
* imgproxy supports authorization by HTTP header. This prevents imgproxy from being used directly by an attacker but allows it to be used via a CDN or a caching server — simply by adding a header to a proxy or CDN config.
98+
## Supporting imgproxy
5499

55-
## Author
100+
imgproxy is not a side project; it's what we do for a living. We work hard to make it better every day. If you find imgproxy useful and want to support its development, here are some ways you can do that:
56101

57-
Sergey "[DarthSim](https://github.com/DarthSim)" Alexandrovich
102+
* **imgproxy Pro subscription.** [imgproxy Pro](https://imgproxy.net/#pro) is a more feature-rich version of imgproxy. By subscribing to imgproxy Pro, you not only support the development of imgproxy but also get access to advanced features and priority support.
103+
* **Sponsorship.** If you don't need the Pro features but still want to support the project, consider sponsoring us on [GitHub Sponsors](https://github.com/sponsors/imgproxy).
104+
* **Spread the word.** If you like imgproxy, give it a shoutout. We don't spend much on marketing, and imgproxy's popularity is primarily a result of our valued users sharing it on social media and blogs.
58105

59106
## Special thanks
60107

@@ -70,3 +117,7 @@ Many thanks to:
70117
imgproxy is licensed under the MIT license.
71118

72119
See [LICENSE](https://github.com/imgproxy/imgproxy/blob/master/LICENSE) for the full license text.
120+
121+
## Security Contact
122+
123+
To report a security vulnerability, please contact us at [email protected]. We will coordinate the fix and disclosure.

src/css/intro.css

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,18 @@
33
max-width: 100%;
44
}
55

6-
.intro__logo-light {
6+
.intro__img {
7+
max-width: 100%;
8+
}
9+
10+
.intro__img-light {
711
display: block;
812

913
[data-theme='dark'] & {
1014
display: none;
1115
}
1216
}
13-
.intro__logo-dark {
17+
.intro__img-dark {
1418
display: none;
1519

1620
[data-theme='dark'] & {

static/img/how-it-works-dark.png

591 KB
Loading

static/img/how-it-works-light.png

605 KB
Loading

0 commit comments

Comments
 (0)