mirror of
https://github.com/imgproxy/imgproxy.git
synced 2025-01-08 10:45:04 +02:00
Fix links in docs
This commit is contained in:
DarthSim
parent
d6f5559fa7
commit
0966e41a2a
@ -15,9 +15,9 @@ If you don't have docker, you can use Heroku for a quick start.
|
||||
|
||||
[](https://heroku.com/deploy)
|
||||
|
||||
Check out our [installation guide](../docs/installation.md) for more details and instructions.
|
||||
Check out our [installation guide](./installation.md) for more details and instructions.
|
||||
|
||||
That's it! No further configuration is needed, but if you want to unleash the full power of imgproxy, read our [configuration guide](../docs/configuration.md).
|
||||
That's it! No further configuration is needed, but if you want to unleash the full power of imgproxy, read our [configuration guide](./configuration.md).
|
||||
|
||||
## Resize an image
|
||||
|
||||
@ -26,8 +26,8 @@ After you installed imgproxy, you can use the following URL to get the resized i
|
||||
|
||||
[The original image](https://m.media-amazon.com/images/M/MV5BMmQ3ZmY4NzYtY2VmYi00ZDRmLTgyODAtZWYzZjhlNzk1NzU2XkEyXkFqcGdeQXVyNTc3MjUzNTI@.jpg) is resized to fill `300x400` with smart gravity. `libvips` chose the most interesting part of the image.
|
||||
|
||||
Get more info about generation imgproxy URLs in the [Generating the URL](../docs/generating_the_url_basic.md) guide.
|
||||
Get more info about generation imgproxy URLs in the [Generating the URL](./generating_the_url_basic.md) guide.
|
||||
|
||||
## Security
|
||||
|
||||
Note that this URL is not signed. It's highly recommended to sign URLs in production. Read our [Signing the URL](../docs/signing_the_url.md) guide to know how to secure your imgproxy from attackers.
|
||||
Note that this URL is not signed. It's highly recommended to sign URLs in production. Read our [Signing the URL](./signing_the_url.md) guide to know how to secure your imgproxy from attackers.
|
||||
|
||||
@ -70,7 +70,7 @@ When WebP support detection is enabled, take care to configure your CDN or cachi
|
||||
|
||||
### Presets
|
||||
|
||||
Read about presets in the [Presets](../docs/presets.md) guide.
|
||||
Read about presets in the [Presets](./presets.md) guide.
|
||||
|
||||
There are two ways to define presets:
|
||||
|
||||
@ -102,7 +102,7 @@ imgproxy can serve your local images, but this feature is disabled by default. T
|
||||
|
||||
* `IMGPROXY_LOCAL_FILESYSTEM_ROOT` — the root of the local filesystem. Keep empty to disable serving of local files.
|
||||
|
||||
Check out [Serving local files](../docs/serving_local_files.md) guide to get more info.
|
||||
Check out [Serving local files](./serving_local_files.md) guide to get more info.
|
||||
|
||||
### Serving files from Amazon S3
|
||||
|
||||
@ -110,7 +110,7 @@ imgproxy can process files from Amazon S3 buckets, but this feature is disabled
|
||||
|
||||
* `IMGPROXY_USE_S3` — when `true`, enables fetching the images from Amazon S3 buckets. Default: false.
|
||||
|
||||
Check out [Serving files from S3](../docs/serving_files_from_s3.md) guide to get more info.
|
||||
Check out [Serving files from S3](./serving_files_from_s3.md) guide to get more info.
|
||||
|
||||
### Miscellaneous
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Generating the URL (Advanced)
|
||||
|
||||
This guide describes the advanced URL format that supports all the imgproxy features. Read our [Generating the URL (Basic)](../docs/generating_the_url_basic.md) guide to get info about basic URL format that is compatible with the first version of imgproxy.
|
||||
This guide describes the advanced URL format that supports all the imgproxy features. Read our [Generating the URL (Basic)](./generating_the_url_basic.md) guide to get info about basic URL format that is compatible with the first version of imgproxy.
|
||||
|
||||
### Format definition
|
||||
|
||||
@ -16,7 +16,7 @@ Check out the [example](#example) at the end of this guide.
|
||||
|
||||
Signature protects your URL from being changed by an attacker. It's highly recommended to sign imgproxy URLs in production.
|
||||
|
||||
If you set up [URL signature](../docs/configuration.md#url-signature), check out [Signing the URL](../docs/signing_the_url.md) guide to know how to sign your URLs. Otherwise, use any string here.
|
||||
If you set up [URL signature](./configuration.md#url-signature), check out [Signing the URL](./signing_the_url.md) guide to know how to sign your URLs. Otherwise, use any string here.
|
||||
|
||||
#### Processing options
|
||||
|
||||
@ -26,7 +26,7 @@ Processing options should be specified as URL parts divided by slashes (`/`). Pr
|
||||
%option_name:%argument1:%argument2:...:argumentN
|
||||
```
|
||||
|
||||
Processing options should not be treated as a processing pipeline. Processing pipeline of imgproxy is fixed to provide you a maximum performance. Read more about it in [About processing pipeline](../docs/about_processing_pipeline.md) guide.
|
||||
Processing options should not be treated as a processing pipeline. Processing pipeline of imgproxy is fixed to provide you a maximum performance. Read more about it in [About processing pipeline](./about_processing_pipeline.md) guide.
|
||||
|
||||
imgproxy supports the following processing options:
|
||||
|
||||
@ -142,7 +142,7 @@ Default: disabled
|
||||
|
||||
Defines presets to be used by imgproxy. Feel free to use as many presets in a single URL as you need.
|
||||
|
||||
Read more about presets in our [Presets](../docs/presets.md) guide.
|
||||
Read more about presets in our [Presets](./presets.md) guide.
|
||||
|
||||
Default: empty
|
||||
|
||||
@ -164,7 +164,7 @@ The source URL should be encoded with URL-safe Base64. The encoded URL can be sp
|
||||
|
||||
Extension specifies the format of the resulting image. At the moment, imgproxy supports only `jpg`, `png` and `webp`, them being the most popular and useful web image formats.
|
||||
|
||||
The extension part can be omitted. In this case, if the format is not defined by processing options, imgproxy will use `jpg` by default. You also can [enable WebP support detection](../docs/configuration.md#webp-support-detection) to use it as default resulting format when possible.
|
||||
The extension part can be omitted. In this case, if the format is not defined by processing options, imgproxy will use `jpg` by default. You also can [enable WebP support detection](./configuration.md#webp-support-detection) to use it as default resulting format when possible.
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Generating the URL (Basic)
|
||||
|
||||
This guide describes the simple URL format that is easy to use but doesn't support the whole range of imgproxy features. This URL format is mostly backward-compatible with the first version of imgproxy. Read our [Generating the URL (Advanced)](../docs/generating_the_url_advanced.md) guide to get info about advanced URL format.
|
||||
This guide describes the simple URL format that is easy to use but doesn't support the whole range of imgproxy features. This URL format is mostly backward-compatible with the first version of imgproxy. Read our [Generating the URL (Advanced)](./generating_the_url_advanced.md) guide to get info about advanced URL format.
|
||||
|
||||
### Format definition
|
||||
|
||||
@ -16,7 +16,7 @@ Check out the [example](#example) at the end of this guide.
|
||||
|
||||
Signature protects your URL from being changed by an attacker. It's highly recommended to sign imgproxy URLs in production.
|
||||
|
||||
If you set up [URL signature](../docs/configuration.md#url-signature), check out [Signing the URL](../docs/signing_the_url.md) guide to know how to sign your URLs. Otherwise, use any string here.
|
||||
If you set up [URL signature](./configuration.md#url-signature), check out [Signing the URL](./signing_the_url.md) guide to know how to sign your URLs. Otherwise, use any string here.
|
||||
|
||||
#### Resizing types
|
||||
|
||||
@ -54,7 +54,7 @@ The source URL should be encoded with URL-safe Base64. The encoded URL can be sp
|
||||
|
||||
Extension specifies the format of the resulting image. At the moment, imgproxy supports only `jpg`, `png` and `webp`, them being the most popular and useful web image formats.
|
||||
|
||||
The extension part can be omitted. In this case, imgproxy will use `jpg` by default. You also can [enable WebP support detection](../docs/configuration.md#webp-support-detection) to use it as default resulting format when possible.
|
||||
The extension part can be omitted. In this case, imgproxy will use `jpg` by default. You also can [enable WebP support detection](./configuration.md#webp-support-detection) to use it as default resulting format when possible.
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Presets
|
||||
|
||||
Preset is named set of processing options. Presets can be used in [advanced URL format](../docs/generating_the_url_advanced.md#preset) to get shorter and more readable URLs.
|
||||
Preset is named set of processing options. Presets can be used in [advanced URL format](./generating_the_url_advanced.md#preset) to get shorter and more readable URLs.
|
||||
|
||||
### Presets definition
|
||||
|
||||
@ -10,13 +10,13 @@ Preset definition looks like this:
|
||||
%preset_name=%processing_options
|
||||
```
|
||||
|
||||
Processing options should be defined the same way as you define them in the [advanced URL format](../docs/generating_the_url_advanced.md#preset). For example, preset named `awesome` that sets the resizing type to `fill` and resulting format to `jpg` will look like this:
|
||||
Processing options should be defined the same way as you define them in the [advanced URL format](./generating_the_url_advanced.md#preset). For example, preset named `awesome` that sets the resizing type to `fill` and resulting format to `jpg` will look like this:
|
||||
|
||||
```
|
||||
awesome=resizing_type:fill/format:jpg
|
||||
```
|
||||
|
||||
Read how to specify your presets to imgproxy in [Configuration](../docs/configuration.md) guide.
|
||||
Read how to specify your presets to imgproxy in [Configuration](./configuration.md) guide.
|
||||
|
||||
### Default preset
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ URL signature checking is disabled by default, but it's highly recommended to en
|
||||
* `IMGPROXY_KEY` — hex-encoded key;
|
||||
* `IMGPROXY_SALT` — hex-encoded salt;
|
||||
|
||||
Read our [Configuration](../docs/configuration.md#url-signature) guide to find more ways to set key and salt.
|
||||
Read our [Configuration](./configuration.md#url-signature) guide to find more ways to set key and salt.
|
||||
|
||||
If you need a random key/salt pair real fast, you can quickly generate it using, for example, the following snippet:
|
||||
|
||||
@ -22,15 +22,15 @@ $ echo $(xxd -g 2 -l 64 -p /dev/random | tr -d '\n')
|
||||
Signature is a URL-safe Base64-encoded HMAC digest of the rest of the path including the leading `/`. Here's how it is calculated:
|
||||
|
||||
* Take the path after the signature:
|
||||
* For [basic URL format](../docs/generating_the_url_basic.md) - `/%resizing_type/%width/%height/%gravity/%enlarge/%encoded_url.%extension`;
|
||||
* For [advanced URL format](../docs/generating_the_url_advanced.md) - `/%processing_options/%encoded_url.%extension`;
|
||||
* For [basic URL format](./generating_the_url_basic.md) - `/%resizing_type/%width/%height/%gravity/%enlarge/%encoded_url.%extension`;
|
||||
* For [advanced URL format](./generating_the_url_advanced.md) - `/%processing_options/%encoded_url.%extension`;
|
||||
* Add salt to the beginning;
|
||||
* Calculate the HMAC digest using SHA256;
|
||||
* Encode the result with URL-safe Base64.
|
||||
|
||||
### Example
|
||||
|
||||
You can find helpful code snippets in the [examples](../../examples) folder. And here is a step-by-step example of calculating URL signature:
|
||||
You can find helpful code snippets in the [examples](../examples) folder. And here is a step-by-step example of calculating URL signature:
|
||||
|
||||
Assume that you have the following unsigned URL:
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user