highperfocused/imgproxy
1
0
Fork 0
mirror of https://github.com/imgproxy/imgproxy.git synced 2025-09-29 04:53:05 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add warning about signature to docs

Browse Source
This commit is contained in:
DarthSim
2023-10-22 20:17:43 +03:00
parent c200fc2a0a
commit 6d511a80ce
2 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/generating_the_url.md
View File

@@ -11,6 +11,8 @@ Check out the [example](#example) at the end of this guide.
## Signature
**⚠️ Warning:** The signature part should always be present in a URL. If the signature check is disabled (no key/salt pairs are provided), the signature part may contain anything (for example, `unsafe` or `_`).
A signature protects your URL from being altered by an attacker. It is highly recommended to sign imgproxy URLs when imgproxy is being used in production.
Once you set up your [URL signature](configuration.md#url-signature), check out the [Signing the URL](signing_the_url.md) guide to find out how to sign your URLs. Otherwise, since the signature still needs to be present, feel free to use any string here.

2
docs/getting_the_image_info.md
View File

@@ -13,6 +13,8 @@ To get the image info, use the following URL format:
## Signature
**⚠️ Warning:** The signature part should always be present in a URL. If the signature check is disabled (no key/salt pairs are provided), the signature part may contain anything (for example, `unsafe` or `_`).
A signature protects your URL from being modified by an attacker. It is highly recommended to sign imgproxy URLs in a production environment.
Once you set up your [URL signature](configuration.md#url-signature), check out the [Signing the URL](signing_the_url.md) guide to learn about how to sign your URLs. Otherwise, since the signature is required, feel free to use any string here.