Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC-2597: Provide demo for Image Optimizer Signed Uploads option #3572

Open
wants to merge 3 commits into
base: tinymce/7
Choose a base branch
from
+13 −5
Open

DOC-2597: Provide demo for Image Optimizer Signed Uploads option #3572

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d16c1bf
DOC-2597: Add link to official Uploadcare documentation for Signed Up…
FarzadHayat Jan 2, 2025
8924893
DOC-2597: Add admonition with link to Signed Uploads starter project
FarzadHayat Jan 2, 2025
15af64d
DOC-2597: Update description for store type to be more accurate
FarzadHayat Jan 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion modules/ROOT/partials/configuration/uploadcare_signed_upload_auth_provider.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ Specifies a function used to generate secure signatures for authenticated reques

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

For more information on Uploadcare Signed Uploads, refer to the official documentation at link:https://uploadcare.com/docs/security/secure-uploads/[Uploadcare Signed Uploads].

*Type:* `+Function+`

=== Example: Setting `uploadcare_signed_upload_auth_provider`
Expand All @@ -16,13 +18,19 @@ tinymce.init({
plugins: 'uploadcare',
toolbar: 'uploadcare',
uploadcare_public_key: '<your-public-key>',
uploadcare_signed_upload_auth_provider: (_publicKey) => Promise.resolve({
uploadcare_signed_upload_auth_provider: (publicKey) => Promise.resolve({
signature: 'sig',
expire: 123
}),
});
----

[TIP]
.Starter Project
====
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. Just clone the repository and follow the steps to set up the project. The link will take you to the GitHub page for the starter project, where the source code is available for you to view: link:https://github.com/tinymce/tinymce-uploadcare-signed-uploads-starter[{productname} {pluginname} Signed Uploads Starter Project].
====

[IMPORTANT]
====
{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:
Expand Down
8 changes: 4 additions & 4 deletions modules/ROOT/partials/configuration/uploadcare_store_type.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[[uploadcare-store-type]]
== `uploadcare_store_type`

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.
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.

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

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.
Expand All @@ -24,6 +24,6 @@ tinymce.init({
plugins: 'uploadcare',
toolbar: 'uploadcare',
uploadcare_public_key: '<your-public-key>',
uploadcare_store_type: 'permanent',
uploadcare_store_type: 'temporary',
});
----
Loading