mirror of
https://github.com/imgproxy/imgproxy.git
synced 2024-11-24 08:12:38 +02:00
c51521961f
* Update landing page / README.md * Update GETTING_STARTED.md * Update installation.md * Update getting_the_image_info.md * update signing_the_url.md * Update watermark.md * Update presets.md * Update object_detection.md * Update autoquality.md * Update serving_local_files.md * Update docs/serving_files_from_s3.md * Update configuration.md * Update generating_the_url.md * Update chained_pipelines.md but chained pipelines section is not finished * Update serving_files_from_google_cloud_storage.md * Update new_relic.md * Update prometheus.md * Update datadog.md * Update image_formats_support.md * Update about_processing_pipeline.md * Update healthcheck.md * Update memory_usage_tweaks.md * Remove GIF/ICO/BMP/HEIF/AVIF support sections from docs/image_formats_support.md * Minor fixes of the docs * Update serving_files_from_azure_blob_storage.md * Fix issue with x and y offset for 're' watermark property * Fix params description in docs/watermark.md * Fix Alexander Madyankin GH name * Special thanks to Travis * Fix README Co-authored-by: DarthSim <darthsim@gmail.com>
34 lines
1.2 KiB
Markdown
34 lines
1.2 KiB
Markdown
# Presets
|
|
|
|
An imgproxy preset is a named set of processing options. Presets can be used in [URLs](generating_the_url.md#preset) to make shorter and more human-readable.
|
|
|
|
## Presets definition
|
|
|
|
A preset definition looks like this:
|
|
|
|
```
|
|
%preset_name=%processing_options
|
|
```
|
|
|
|
Processing options should be defined in the same way they are defined in [URLs](generating_the_url.md#processing-options). For example, here's a preset named `awesome` that sets the resizing type to `fill` and the resulting format to `jpg`:
|
|
|
|
```
|
|
awesome=resizing_type:fill/format:jpg
|
|
```
|
|
|
|
Read how to specify your presets with imgproxy in the [Configuration](configuration.md) guide.
|
|
|
|
## Default preset
|
|
|
|
A preset named `default` will be applied to each image. This is useful when you want your default processing options to be different from the default imgproxy options.
|
|
|
|
## Only presets
|
|
|
|
Setting `IMGPROXY_ONLY_PRESETS` to `true` switches imgproxy into "presets-only mode". In this mode, imgproxy accepts a presets list as processing options just like you'd specify them for the `preset` option:
|
|
|
|
```
|
|
http://imgproxy.example.com/unsafe/thumbnail:blurry:watermarked/plain/http://example.com/images/curiosity.jpg@png
|
|
```
|
|
|
|
All othe URL formats are disabled in this mode.
|