Skip to content

Commit 3844b1e

Browse files
Farzad Hayatkemister85
andauthored
DOC-2597: Provide demo for Image Optimizer Signed Uploads option (#3572)
* DOC-2597: Add link to official Uploadcare documentation for Signed Uploads * DOC-2597: Add admonition with link to Signed Uploads starter project * DOC-2597: Update description for store type to be more accurate * Update modules/ROOT/partials/configuration/uploadcare_signed_upload_auth_provider.adoc Co-authored-by: Karl Kemister-Sheppard <[email protected]> --------- Co-authored-by: Karl Kemister-Sheppard <[email protected]>
1 parent 2118cef commit 3844b1e

File tree

2 files changed

+13
-5
lines changed

2 files changed

+13
-5
lines changed

modules/ROOT/partials/configuration/uploadcare_signed_upload_auth_provider.adoc

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ Specifies a function used to generate secure signatures for authenticated reques
55

66
Use this option to enforce secure uploads, preventing unauthorized users from uploading files via your application.
77

8+
For more information on Uploadcare Signed Uploads, refer to the official documentation at link:https://uploadcare.com/docs/security/secure-uploads/[Uploadcare Signed Uploads].
9+
810
*Type:* `+Function+`
911

1012
=== Example: Setting `uploadcare_signed_upload_auth_provider`
@@ -16,13 +18,19 @@ tinymce.init({
1618
plugins: 'uploadcare',
1719
toolbar: 'uploadcare',
1820
uploadcare_public_key: '<your-public-key>',
19-
uploadcare_signed_upload_auth_provider: (_publicKey) => Promise.resolve({
21+
uploadcare_signed_upload_auth_provider: (publicKey) => Promise.resolve({
2022
signature: 'sig',
2123
expire: 123
2224
}),
2325
});
2426
----
2527

28+
[TIP]
29+
.Starter Project
30+
====
31+
To get started quickly and understand how Uploadcare Signed Uploads integrates with {productname} {pluginname}, {companyname} recommends trying the starter project on GitHub to set up {pluginname} with Signed Uploads. Clone the repository and follow the steps to set up the project. The link leads to the GitHub page for the starter project, where the source code is available for viewing: link:https://github.com/tinymce/tinymce-uploadcare-signed-uploads-starter[{productname} {pluginname} Signed Uploads Starter Project].
32+
====
33+
2634
[IMPORTANT]
2735
====
2836
{companyname} recommends configuring the `uploadcare_signed_upload_auth_provider` option to secure uploads and prevent misuse of your Uploadcare `uploadcare_public_key`. This option is essential for applications requiring:

modules/ROOT/partials/configuration/uploadcare_store_type.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
[[uploadcare-store-type]]
22
== `uploadcare_store_type`
33

4-
Specifies the storage type for uploaded files. Use this option to control whether files are stored temporarily or permanently, or allow Uploadcare to decide automatically based on your account settings.
4+
Specifies the storage type for uploaded files. Use this option to control whether files are stored temporarily or permanently, or allow Uploadcare to decide automatically based on your project settings.
55

6-
* `auto`: Uploadcare decides the storage type.
7-
* `temporary`: Files are stored temporarily and will expire after a certain period.
6+
* `auto`: Defer the choice of storage behavior to the auto-store setting in the Uploadcare Dashboard.
7+
* `temporary`: Files are stored temporarily and removed after 24 hours.
88
* `permanent`: Files are stored permanently in your Uploadcare account.
99

1010
Select the appropriate value based on your application's requirements, such as whether files should persist for long-term use or be available for a limited time.
@@ -24,6 +24,6 @@ tinymce.init({
2424
plugins: 'uploadcare',
2525
toolbar: 'uploadcare',
2626
uploadcare_public_key: '<your-public-key>',
27-
uploadcare_store_type: 'permanent',
27+
uploadcare_store_type: 'temporary',
2828
});
2929
----

0 commit comments

Comments
 (0)