Skip to content

Commit 0046263

Browse files
DarthSimDarthSim
committed
Clarify URL-escaping when using plain source URLs
1 parent 7a1b217 commit 0046263

File tree

22 files changed

+154
-22
lines changed

22 files changed

+154
-22
lines changed

‎docs/usage/getting_info.mdx‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -727,7 +727,13 @@ The source URL can be provided as is, prepended by `/plain/` part:
727727
```
728728

729729
:::info
730-
If the source URL contains a query string or `@`, you'll need to escape it.
730+
imgproxy expects the source URL to be escaped (percent-encoded) when using the `/plain/` segment.
731+
732+
If you don't want to percent-encode all the special characters in the source URL, you can replace only the ones that can cause issues with imgproxy:
733+
734+
* Replace `%` with `%25` (you should do this before percent-encoding the rest of the URL)
735+
* Replace `?` with `%3F`
736+
* Replace `@` with `%40`
731737
:::
732738

733739
### Base64 encoded

‎docs/usage/processing.mdx‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1157,7 +1157,13 @@ The source URL can be provided as is, prepended by the `/plain/` segment:
11571157
```
11581158

11591159
:::info
1160-
If the source URL contains a query string or `@`, you'll need to escape it.
1160+
imgproxy expects the source URL to be escaped (percent-encoded) when using the `/plain/` segment.
1161+
1162+
If you don't want to percent-encode all the special characters in the source URL, you can replace only the ones that can cause issues with imgproxy:
1163+
1164+
* Replace `%` with `%25` (you should do this before percent-encoding the rest of the URL)
1165+
* Replace `?` with `%3F`
1166+
* Replace `@` with `%40`
11611167
:::
11621168

11631169
When using a plain source URL, you can specify the [extension](#extension) after `@`:

‎versioned_docs/version-3.19.x/usage/getting_info.mdx‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,13 @@ The source URL can be provided as is, prepended by `/plain/` part:
3535
```
3636

3737
:::info
38-
If the source URL contains a query string or `@`, you'll need to escape it.
38+
imgproxy expects the source URL to be escaped (percent-encoded) when using the `/plain/` segment.
39+
40+
If you don't want to percent-encode all the special characters in the source URL, you can replace only the ones that can cause issues with imgproxy:
41+
42+
* Replace `%` with `%25` (you should do this before percent-encoding the rest of the URL)
43+
* Replace `?` with `%3F`
44+
* Replace `@` with `%40`
3945
:::
4046

4147
### Base64 encoded

‎versioned_docs/version-3.19.x/usage/processing.mdx‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -933,7 +933,13 @@ The source URL can be provided as is, prepended by the `/plain/` segment:
933933
```
934934

935935
:::info
936-
If the source URL contains a query string or `@`, you'll need to escape it.
936+
imgproxy expects the source URL to be escaped (percent-encoded) when using the `/plain/` segment.
937+
938+
If you don't want to percent-encode all the special characters in the source URL, you can replace only the ones that can cause issues with imgproxy:
939+
940+
* Replace `%` with `%25` (you should do this before percent-encoding the rest of the URL)
941+
* Replace `?` with `%3F`
942+
* Replace `@` with `%40`
937943
:::
938944

939945
When using a plain source URL, you can specify the [extension](#extension) after `@`:

‎versioned_docs/version-3.20.x/usage/getting_info.mdx‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -516,7 +516,13 @@ The source URL can be provided as is, prepended by `/plain/` part:
516516
```
517517

518518
:::info
519-
If the source URL contains a query string or `@`, you'll need to escape it.
519+
imgproxy expects the source URL to be escaped (percent-encoded) when using the `/plain/` segment.
520+
521+
If you don't want to percent-encode all the special characters in the source URL, you can replace only the ones that can cause issues with imgproxy:
522+
523+
* Replace `%` with `%25` (you should do this before percent-encoding the rest of the URL)
524+
* Replace `?` with `%3F`
525+
* Replace `@` with `%40`
520526
:::
521527

522528
### Base64 encoded

‎versioned_docs/version-3.20.x/usage/processing.mdx‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -933,7 +933,13 @@ The source URL can be provided as is, prepended by the `/plain/` segment:
933933
```
934934

935935
:::info
936-
If the source URL contains a query string or `@`, you'll need to escape it.
936+
imgproxy expects the source URL to be escaped (percent-encoded) when using the `/plain/` segment.
937+
938+
If you don't want to percent-encode all the special characters in the source URL, you can replace only the ones that can cause issues with imgproxy:
939+
940+
* Replace `%` with `%25` (you should do this before percent-encoding the rest of the URL)
941+
* Replace `?` with `%3F`
942+
* Replace `@` with `%40`
937943
:::
938944

939945
When using a plain source URL, you can specify the [extension](#extension) after `@`:

‎versioned_docs/version-3.21.x/usage/getting_info.mdx‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -643,7 +643,13 @@ The source URL can be provided as is, prepended by `/plain/` part:
643643
```
644644

645645
:::info
646-
If the source URL contains a query string or `@`, you'll need to escape it.
646+
imgproxy expects the source URL to be escaped (percent-encoded) when using the `/plain/` segment.
647+
648+
If you don't want to percent-encode all the special characters in the source URL, you can replace only the ones that can cause issues with imgproxy:
649+
650+
* Replace `%` with `%25` (you should do this before percent-encoding the rest of the URL)
651+
* Replace `?` with `%3F`
652+
* Replace `@` with `%40`
647653
:::
648654

649655
### Base64 encoded

‎versioned_docs/version-3.21.x/usage/processing.mdx‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -964,7 +964,13 @@ The source URL can be provided as is, prepended by the `/plain/` segment:
964964
```
965965

966966
:::info
967-
If the source URL contains a query string or `@`, you'll need to escape it.
967+
imgproxy expects the source URL to be escaped (percent-encoded) when using the `/plain/` segment.
968+
969+
If you don't want to percent-encode all the special characters in the source URL, you can replace only the ones that can cause issues with imgproxy:
970+
971+
* Replace `%` with `%25` (you should do this before percent-encoding the rest of the URL)
972+
* Replace `?` with `%3F`
973+
* Replace `@` with `%40`
968974
:::
969975

970976
When using a plain source URL, you can specify the [extension](#extension) after `@`:

‎versioned_docs/version-3.22.x/usage/getting_info.mdx‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -700,7 +700,13 @@ The source URL can be provided as is, prepended by `/plain/` part:
700700
```
701701

702702
:::info
703-
If the source URL contains a query string or `@`, you'll need to escape it.
703+
imgproxy expects the source URL to be escaped (percent-encoded) when using the `/plain/` segment.
704+
705+
If you don't want to percent-encode all the special characters in the source URL, you can replace only the ones that can cause issues with imgproxy:
706+
707+
* Replace `%` with `%25` (you should do this before percent-encoding the rest of the URL)
708+
* Replace `?` with `%3F`
709+
* Replace `@` with `%40`
704710
:::
705711

706712
### Base64 encoded

‎versioned_docs/version-3.22.x/usage/processing.mdx‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -998,7 +998,13 @@ The source URL can be provided as is, prepended by the `/plain/` segment:
998998
```
999999

10001000
:::info
1001-
If the source URL contains a query string or `@`, you'll need to escape it.
1001+
imgproxy expects the source URL to be escaped (percent-encoded) when using the `/plain/` segment.
1002+
1003+
If you don't want to percent-encode all the special characters in the source URL, you can replace only the ones that can cause issues with imgproxy:
1004+
1005+
* Replace `%` with `%25` (you should do this before percent-encoding the rest of the URL)
1006+
* Replace `?` with `%3F`
1007+
* Replace `@` with `%40`
10021008
:::
10031009

10041010
When using a plain source URL, you can specify the [extension](#extension) after `@`:

0 commit comments

Comments
 (0)