From 62d367d207dfeac56ee66b9134147da65107266e Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 18 Nov 2025 14:08:28 +0000 Subject: [PATCH] deploy: 606bedd2eccad7056927f5590dd3c45fd76b06ff --- 404.html | 4 +- assets/js/0058b4c6.7b6e3fb5.js | 1 - assets/js/0058b4c6.ddb4bff2.js | 1 + assets/js/20f41f87.b83e36a4.js | 1 + assets/js/4acb0154.9d3b7447.js | 1 - assets/js/4acb0154.cc896e9f.js | 1 + assets/js/6bef026b.3c18a97c.js | 1 + assets/js/6bef026b.9462a6b2.js | 1 - assets/js/c1e4445e.8e750522.js | 1 + assets/js/c1e4445e.ca7f10f3.js | 1 - assets/js/dc8c216b.5259eacc.js | 1 - assets/js/dc8c216b.848f2bc3.js | 1 + .../js/{main.2493ad18.js => main.c19202ed.js} | 4 +- ...CENSE.txt => main.c19202ed.js.LICENSE.txt} | 0 assets/js/runtime~main.22bcba31.js | 1 + assets/js/runtime~main.6218f05b.js | 1 - blog/archive/index.html | 4 +- blog/authors/index.html | 4 +- blog/first-blog-post/index.html | 4 +- blog/index.html | 4 +- blog/long-blog-post/index.html | 4 +- blog/mdx-blog-post/index.html | 4 +- blog/tags/docusaurus/index.html | 4 +- blog/tags/facebook/index.html | 4 +- blog/tags/hello/index.html | 4 +- blog/tags/hola/index.html | 4 +- blog/tags/index.html | 4 +- blog/welcome/index.html | 4 +- docs/API-docs/api-intro/index.html | 4 +- docs/API-docs/v1.1/contactlist/index.html | 4 +- docs/API-docs/v1.1/createcontact/index.html | 4 +- docs/API-docs/v1.1/createdocument/index.html | 4 +- .../createdocumentwithtemplateid/index.html | 4 +- docs/API-docs/v1.1/createfolder/index.html | 4 +- docs/API-docs/v1.1/createtemplate/index.html | 4 +- docs/API-docs/v1.1/delete-template/index.html | 4 +- docs/API-docs/v1.1/delete-webhook/index.html | 4 +- docs/API-docs/v1.1/deletecontact/index.html | 4 +- docs/API-docs/v1.1/deletedocument/index.html | 4 +- docs/API-docs/v1.1/deletefolder/index.html | 4 +- docs/API-docs/v1.1/draftdocument/index.html | 4 +- docs/API-docs/v1.1/drafttemplate/index.html | 4 +- docs/API-docs/v1.1/folderlist/index.html | 4 +- docs/API-docs/v1.1/get-template/index.html | 4 +- docs/API-docs/v1.1/get-user/index.html | 4 +- docs/API-docs/v1.1/get-webhook/index.html | 4 +- docs/API-docs/v1.1/getcontact/index.html | 4 +- docs/API-docs/v1.1/getcredits/index.html | 4 +- docs/API-docs/v1.1/getdocument/index.html | 4 +- docs/API-docs/v1.1/getdocumentlist/index.html | 4 +- docs/API-docs/v1.1/getfolder/index.html | 4 +- docs/API-docs/v1.1/gettemplatelist/index.html | 4 +- docs/API-docs/v1.1/index.html | 4 +- docs/API-docs/v1.1/intro/index.html | 4 +- .../v1.1/opensign-api-v-1-1/index.html | 4 +- docs/API-docs/v1.1/publictemplate/index.html | 4 +- .../v1.1/resendrequestmail/index.html | 4 +- docs/API-docs/v1.1/revokedocument/index.html | 4 +- .../v1.1/save-update-webhook/index.html | 4 +- docs/API-docs/v1.1/selfsign/index.html | 4 +- docs/API-docs/v1.1/update-document/index.html | 4 +- docs/API-docs/v1.1/update-template/index.html | 4 +- docs/API-docs/v1.1/updatefolder/index.html | 4 +- docs/API-docs/v1/contactlist/index.html | 4 +- docs/API-docs/v1/createcontact/index.html | 4 +- docs/API-docs/v1/createdocument/index.html | 4 +- .../createdocumentwithtemplateid/index.html | 4 +- docs/API-docs/v1/createfolder/index.html | 4 +- docs/API-docs/v1/createtemplate/index.html | 4 +- docs/API-docs/v1/delete-template/index.html | 4 +- docs/API-docs/v1/delete-webhook/index.html | 4 +- docs/API-docs/v1/deletecontact/index.html | 4 +- docs/API-docs/v1/deletedocument/index.html | 4 +- docs/API-docs/v1/deletefolder/index.html | 4 +- docs/API-docs/v1/draftdocument/index.html | 4 +- docs/API-docs/v1/drafttemplate/index.html | 4 +- docs/API-docs/v1/folderlist/index.html | 4 +- docs/API-docs/v1/get-template/index.html | 4 +- docs/API-docs/v1/get-user/index.html | 4 +- docs/API-docs/v1/get-webhook/index.html | 4 +- docs/API-docs/v1/getcontact/index.html | 4 +- docs/API-docs/v1/getdocument/index.html | 4 +- docs/API-docs/v1/getdocumentlist/index.html | 4 +- docs/API-docs/v1/getfolder/index.html | 4 +- docs/API-docs/v1/gettemplatelist/index.html | 4 +- docs/API-docs/v1/index.html | 4 +- docs/API-docs/v1/intro/index.html | 4 +- docs/API-docs/v1/opensign-api-v-1/index.html | 4 +- docs/API-docs/v1/resendrequestmail/index.html | 4 +- docs/API-docs/v1/revokedocument/index.html | 4 +- .../v1/save-update-webhook/index.html | 4 +- docs/API-docs/v1/selfsign/index.html | 4 +- docs/API-docs/v1/update-document/index.html | 4 +- docs/API-docs/v1/update-template/index.html | 4 +- docs/API-docs/v1/updatefolder/index.html | 4 +- docs/category/cloud-storage/index.html | 4 +- docs/category/console/index.html | 6 +- .../create-new-opensign-document/index.html | 4 +- docs/category/docker/index.html | 4 +- docs/category/documents/index.html | 4 +- docs/category/faqs/index.html | 4 +- docs/category/guides/index.html | 4 +- .../index.html | 4 +- docs/category/settings/index.html | 4 +- docs/category/templates/index.html | 4 +- docs/category/user-menu/index.html | 6 +- docs/contribute/CODE_OF_CONDUCT/index.html | 4 +- docs/contribute/COMMUNITY/index.html | 4 +- docs/contribute/INSTALLATION/index.html | 4 +- .../REPORTING_GUIDELINES/index.html | 4 +- docs/contribute/intro/index.html | 4 +- .../index.html | 4 +- .../help/FAQs/Max File Upload Size/index.html | 4 +- docs/help/FAQs/User Deletion/index.html | 4 +- docs/help/FAQs/index.html | 4 +- .../edit-document-before-sending/index.html | 4 +- .../enforce-email-verification/index.html | 4 +- .../request-signatures/index.html | 4 +- .../New-Document/sign-yourself/index.html | 4 +- docs/help/New-Document/widgets/index.html | 4 +- .../create-document/index.html | 4 +- .../OpenSign™ Drive/list-grid-view/index.html | 4 +- .../organize-documents/index.html | 4 +- .../rename-document/index.html | 4 +- docs/help/Reports/completed/index.html | 4 +- docs/help/Reports/contactbook/index.html | 4 +- docs/help/Reports/declined/index.html | 4 +- docs/help/Reports/drafts/index.html | 4 +- docs/help/Reports/expired/index.html | 4 +- docs/help/Reports/in-progress/index.html | 4 +- docs/help/Reports/need-your-sign/index.html | 4 +- docs/help/Settings/APIToken/index.html | 4 +- .../Custom-email-templates/index.html | 4 +- docs/help/Settings/Preferences/index.html | 50 ++++++---------- .../Settings/SecurityManagement/index.html | 4 +- docs/help/Settings/Teams/index.html | 4 +- docs/help/Settings/Webhook/index.html | 4 +- .../Settings/disabledocumentid/index.html | 4 +- docs/help/Settings/manage-users/index.html | 4 +- docs/help/Settings/my-signature/index.html | 4 +- .../help/Templates/create-template/index.html | 4 +- docs/help/Templates/embed-template/index.html | 4 +- .../Templates/manage-templates/index.html | 4 +- docs/help/Templates/publicTemplate/index.html | 4 +- docs/help/Templates/quick-send/index.html | 4 +- docs/help/Templates/use-template/index.html | 4 +- .../User Menu/Console/analystics/index.html | 6 +- .../User Menu/Console/branding/index.html | 8 +-- .../Console/custom_filestorage/index.html | 10 ++-- docs/help/User Menu/Console/emails/index.html | 6 +- .../help/User Menu/Console/general/index.html | 17 ++++-- .../User Menu/Console/globalSMTP/index.html | 57 +++++++++++++++++++ .../User Menu/Console/orgadmin/index.html | 6 +- .../Console/organizations/index.html | 6 +- .../Console/signing_certificate/index.html | 8 +-- docs/help/User Menu/Profile/index.html | 4 +- docs/help/intro/index.html | 4 +- docs/intro/index.html | 4 +- .../One-click-Install/DigitalOcean/index.html | 4 +- docs/self-host/cloud-storage/s3/index.html | 4 +- docs/self-host/docker/run-locally/index.html | 4 +- .../docker/upgrade-deployment/index.html | 4 +- .../guides/azure-vm-setup/index.html | 4 +- .../self-host/guides/env-variables/index.html | 4 +- .../index.html | 4 +- .../guides/upgrade-to-v2.1.0/index.html | 4 +- docs/self-host/intro/index.html | 4 +- index.html | 4 +- markdown-page/index.html | 4 +- sitemap.xml | 2 +- 170 files changed, 409 insertions(+), 364 deletions(-) delete mode 100644 assets/js/0058b4c6.7b6e3fb5.js create mode 100644 assets/js/0058b4c6.ddb4bff2.js create mode 100644 assets/js/20f41f87.b83e36a4.js delete mode 100644 assets/js/4acb0154.9d3b7447.js create mode 100644 assets/js/4acb0154.cc896e9f.js create mode 100644 assets/js/6bef026b.3c18a97c.js delete mode 100644 assets/js/6bef026b.9462a6b2.js create mode 100644 assets/js/c1e4445e.8e750522.js delete mode 100644 assets/js/c1e4445e.ca7f10f3.js delete mode 100644 assets/js/dc8c216b.5259eacc.js create mode 100644 assets/js/dc8c216b.848f2bc3.js rename assets/js/{main.2493ad18.js => main.c19202ed.js} (53%) rename assets/js/{main.2493ad18.js.LICENSE.txt => main.c19202ed.js.LICENSE.txt} (100%) create mode 100644 assets/js/runtime~main.22bcba31.js delete mode 100644 assets/js/runtime~main.6218f05b.js create mode 100644 docs/help/User Menu/Console/globalSMTP/index.html diff --git a/404.html b/404.html index 9b9edb319..3ba5d4f42 100644 --- a/404.html +++ b/404.html @@ -5,8 +5,8 @@ Page Not Found | OpenSign™ - - + +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

diff --git a/assets/js/0058b4c6.7b6e3fb5.js b/assets/js/0058b4c6.7b6e3fb5.js deleted file mode 100644 index 2072c45a5..000000000 --- a/assets/js/0058b4c6.7b6e3fb5.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[849],{86164:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Intro","href":"/docs/help/intro","docId":"help/intro","unlisted":false},{"type":"category","label":"Create New OpenSign Document","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Sign your-self","href":"/docs/help/New-Document/sign-yourself","docId":"help/New-Document/sign-yourself","unlisted":false},{"type":"link","label":"Request signatures","href":"/docs/help/New-Document/request-signatures","docId":"help/New-Document/request-signatures","unlisted":false},{"type":"link","label":"Widgets in OpenSign","href":"/docs/help/New-Document/widgets","docId":"help/New-Document/widgets","unlisted":false},{"type":"link","label":"Editing Your Document Before Sending","href":"/docs/help/New-Document/edit-document-before-sending","docId":"help/New-Document/edit-document-before-sending","unlisted":false},{"type":"link","label":"Enforce email OTP verification","href":"/docs/help/New-Document/enforce-email-verification","docId":"help/New-Document/enforce-email-verification","unlisted":false}],"href":"/docs/category/create-new-opensign-document"},{"type":"category","label":"Manage Docs using OpenSign\u2122 Drive","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Docs & Folders","href":"/docs/help/OpenSign\u2122 Drive/create-document","docId":"help/OpenSign\u2122 Drive/create-document","unlisted":false},{"type":"link","label":"Grid vs List view","href":"/docs/help/OpenSign\u2122 Drive/list-grid-view","docId":"help/OpenSign\u2122 Drive/list-grid-view","unlisted":false},{"type":"link","label":"OpenSign\u2122 Drive Interface Documentation","href":"/docs/help/OpenSign\u2122 Drive/organize-documents","docId":"help/OpenSign\u2122 Drive/organize-documents","unlisted":false},{"type":"link","label":"Rename documents from OpenSign\u2122 Drive","href":"/docs/help/OpenSign\u2122 Drive/rename-document","docId":"help/OpenSign\u2122 Drive/rename-document","unlisted":false}],"href":"/docs/category/manage-docs-using-opensign-drive"},{"type":"category","label":"Documents","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Need your sign","href":"/docs/help/Reports/need-your-sign","docId":"help/Reports/need-your-sign","unlisted":false},{"type":"link","label":"In Progress","href":"/docs/help/Reports/in-progress","docId":"help/Reports/in-progress","unlisted":false},{"type":"link","label":"Completed","href":"/docs/help/Reports/completed","docId":"help/Reports/completed","unlisted":false},{"type":"link","label":"Drafts","href":"/docs/help/Reports/drafts","docId":"help/Reports/drafts","unlisted":false},{"type":"link","label":"Declined","href":"/docs/help/Reports/declined","docId":"help/Reports/declined","unlisted":false},{"type":"link","label":"Expired","href":"/docs/help/Reports/expired","docId":"help/Reports/expired","unlisted":false},{"type":"link","label":"Contactbook","href":"/docs/help/Reports/contactbook","docId":"help/Reports/contactbook","unlisted":false}],"href":"/docs/category/documents"},{"type":"category","label":"Templates","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Templates","href":"/docs/help/Templates/create-template","docId":"help/Templates/create-template","unlisted":false},{"type":"link","label":"Manage Templates","href":"/docs/help/Templates/manage-templates","docId":"help/Templates/manage-templates","unlisted":false},{"type":"link","label":"Use template to create documents","href":"/docs/help/Templates/use-template","docId":"help/Templates/use-template","unlisted":false},{"type":"link","label":"Quickly Send the Document for Signature Using Template","href":"/docs/help/Templates/quick-send","docId":"help/Templates/quick-send","unlisted":false},{"type":"link","label":"Setting up an OpenSign template for public signing","href":"/docs/help/Templates/publicTemplate","docId":"help/Templates/publicTemplate","unlisted":false},{"type":"link","label":"Embedding OpenSign templates","href":"/docs/help/Templates/embed-template","docId":"help/Templates/embed-template","unlisted":false}],"href":"/docs/category/templates"},{"type":"category","label":"Settings","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"My Signature","href":"/docs/help/Settings/my-signature","docId":"help/Settings/my-signature","unlisted":false},{"type":"link","label":"API Token","href":"/docs/help/Settings/APIToken","docId":"help/Settings/APIToken","unlisted":false},{"type":"link","label":"Webhook","href":"/docs/help/Settings/Webhook","docId":"help/Settings/Webhook","unlisted":false},{"type":"link","label":"Preferences","href":"/docs/help/Settings/Preferences","docId":"help/Settings/Preferences","unlisted":false},{"type":"link","label":"Manage Teams","href":"/docs/help/Settings/Teams","docId":"help/Settings/Teams","unlisted":false},{"type":"link","label":"Manage users","href":"/docs/help/Settings/manage-users","docId":"help/Settings/manage-users","unlisted":false},{"type":"link","label":"Disable DocumentId","href":"/docs/help/Settings/disabledocumentid","docId":"help/Settings/disabledocumentid","unlisted":false},{"type":"link","label":"Custom email templates","href":"/docs/help/Settings/Custom-email-templates","docId":"help/Settings/Custom-email-templates","unlisted":false},{"type":"link","label":"Security","href":"/docs/help/Settings/SecurityManagement","docId":"help/Settings/SecurityManagement","unlisted":false}],"href":"/docs/category/settings"},{"type":"category","label":"User Menu","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Profile","href":"/docs/help/User Menu/Profile","docId":"help/User Menu/Profile","unlisted":false},{"type":"category","label":"Console","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Analytics","href":"/docs/help/User Menu/Console/analystics","docId":"help/User Menu/Console/analystics","unlisted":false},{"type":"link","label":"General","href":"/docs/help/User Menu/Console/general","docId":"help/User Menu/Console/general","unlisted":false},{"type":"link","label":"Branding","href":"/docs/help/User Menu/Console/branding","docId":"help/User Menu/Console/branding","unlisted":false},{"type":"link","label":"Custom File Storage","href":"/docs/help/User Menu/Console/custom_filestorage","docId":"help/User Menu/Console/custom_filestorage","unlisted":false},{"type":"link","label":"Email Templates","href":"/docs/help/User Menu/Console/emails","docId":"help/User Menu/Console/emails","unlisted":false},{"type":"link","label":"Custom Signing Certificate","href":"/docs/help/User Menu/Console/signing_certificate","docId":"help/User Menu/Console/signing_certificate","unlisted":false},{"type":"link","label":"Organizations","href":"/docs/help/User Menu/Console/organizations","docId":"help/User Menu/Console/organizations","unlisted":false},{"type":"link","label":"Org Admins","href":"/docs/help/User Menu/Console/orgadmin","docId":"help/User Menu/Console/orgadmin","unlisted":false}],"href":"/docs/category/console"}],"href":"/docs/category/user-menu"},{"type":"category","label":"FAQs","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Why is there no dropdown list when I sign a document myself?","href":"/docs/help/FAQs/","docId":"help/FAQs/FAQs","unlisted":false},{"type":"link","label":"Why am I getting \'Ensure this field is accurately filled and meets all requirements\'?","href":"/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements","docId":"help/FAQs/Ensure this field is accurately filled and meets all requirements","unlisted":false},{"type":"link","label":"Max File Upload Size","href":"/docs/help/FAQs/Max File Upload Size","docId":"help/FAQs/Max File Upload Size","unlisted":false},{"type":"link","label":"User Deletion","href":"/docs/help/FAQs/User Deletion","docId":"help/FAQs/User Deletion","unlisted":false}],"href":"/docs/category/faqs"}],"selfhostSidebar":[{"type":"link","label":"Self-Hosting OpenSign","href":"/docs/self-host/intro","docId":"self-host/intro","unlisted":false},{"type":"category","label":"Docker","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Self-host OpenSign\u2122 with Docker on Linux/MacOS/Windows","href":"/docs/self-host/docker/run-locally","docId":"self-host/docker/run-locally","unlisted":false},{"type":"link","label":"OpenSign\u2122 Self-Hosted \'Upgrade Deployment\' Guide Using Docker on Linux, macOS, or Windows","href":"/docs/self-host/docker/upgrade-deployment","docId":"self-host/docker/upgrade-deployment","unlisted":false}],"href":"/docs/category/docker"},{"type":"category","label":"Cloud Storage","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"AWS S3","href":"/docs/self-host/cloud-storage/s3","docId":"self-host/cloud-storage/s3","unlisted":false}],"href":"/docs/category/cloud-storage"},{"type":"category","label":"Guides","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"OpenSign Deployment Guide on Azure VM via command-line","href":"/docs/self-host/guides/azure-vm-setup","docId":"self-host/guides/azure-vm-setup","unlisted":false},{"type":"link","label":"ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","href":"/docs/self-host/guides/env-variables","docId":"self-host/guides/env-variables","unlisted":false},{"type":"link","label":"How to generate self-signed document signing certificate?","href":"/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate","docId":"self-host/guides/how-to-generate-self-signed-document-signing-certificate","unlisted":false},{"type":"link","label":"How to upgrade self-hosted OpenSign to v2.1.0?","href":"/docs/self-host/guides/upgrade-to-v2.1.0","docId":"self-host/guides/upgrade-to-v2.1.0","unlisted":false}],"href":"/docs/category/guides"},{"type":"category","label":"One-click-Install","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Digital Ocean","href":"/docs/self-host/One-click-Install/DigitalOcean","docId":"self-host/One-click-Install/DigitalOcean","unlisted":false}]}],"contributeSidebar":[{"type":"link","label":"Code of conduct","href":"/docs/contribute/CODE_OF_CONDUCT","docId":"contribute/CODE_OF_CONDUCT","unlisted":false},{"type":"link","label":"Contributing to OpenSign","href":"/docs/contribute/intro","docId":"contribute/intro","unlisted":false},{"type":"link","label":"Installation instructions","href":"/docs/contribute/INSTALLATION","docId":"contribute/INSTALLATION","unlisted":false},{"type":"link","label":"Community at OpenSign\u2122","href":"/docs/contribute/COMMUNITY","docId":"contribute/COMMUNITY","unlisted":false},{"type":"link","label":"OpenSign\u2122 Reporting Guidelines","href":"/docs/contribute/REPORTING_GUIDELINES","docId":"contribute/REPORTING_GUIDELINES","unlisted":false}],"apiSidebar":[{"type":"category","label":"v1.1","collapsed":false,"items":[{"type":"link","label":"Introduction","href":"/docs/API-docs/v1.1/opensign-api-v-1-1","docId":"API-docs/v1.1/opensign-api-v-1-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","label":"Get your account details","href":"/docs/API-docs/v1.1/get-user","className":"api-method get","docId":"API-docs/v1.1/get-user","unlisted":false},{"type":"link","label":"Get your API credits","href":"/docs/API-docs/v1.1/getcredits","className":"api-method get","docId":"API-docs/v1.1/getcredits","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","label":"Create Contact","href":"/docs/API-docs/v1.1/createcontact","className":"api-method post","docId":"API-docs/v1.1/createcontact","unlisted":false},{"type":"link","label":"Get Contact","href":"/docs/API-docs/v1.1/getcontact","className":"api-method get","docId":"API-docs/v1.1/getcontact","unlisted":false},{"type":"link","label":"Delete Contact","href":"/docs/API-docs/v1.1/deletecontact","className":"api-method delete","docId":"API-docs/v1.1/deletecontact","unlisted":false},{"type":"link","label":"Get Contact list","href":"/docs/API-docs/v1.1/contactlist","className":"api-method get","docId":"API-docs/v1.1/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","label":"Self Sign","href":"/docs/API-docs/v1.1/selfsign","className":"api-method post","docId":"API-docs/v1.1/selfsign","unlisted":false},{"type":"link","label":"Draft Document","href":"/docs/API-docs/v1.1/draftdocument","className":"api-method post","docId":"API-docs/v1.1/draftdocument","unlisted":false},{"type":"link","label":"Create Document","href":"/docs/API-docs/v1.1/createdocument","className":"api-method post","docId":"API-docs/v1.1/createdocument","unlisted":false},{"type":"link","label":"Create Document from Template","href":"/docs/API-docs/v1.1/createdocumentwithtemplateid","className":"api-method post","docId":"API-docs/v1.1/createdocumentwithtemplateid","unlisted":false},{"type":"link","label":"Get Document","href":"/docs/API-docs/v1.1/getdocument","className":"api-method get","docId":"API-docs/v1.1/getdocument","unlisted":false},{"type":"link","label":"Update Document","href":"/docs/API-docs/v1.1/update-document","className":"api-method put","docId":"API-docs/v1.1/update-document","unlisted":false},{"type":"link","label":"Revoke Document","href":"/docs/API-docs/v1.1/revokedocument","className":"api-method post","docId":"API-docs/v1.1/revokedocument","unlisted":false},{"type":"link","label":"Delete Document","href":"/docs/API-docs/v1.1/deletedocument","className":"api-method delete","docId":"API-docs/v1.1/deletedocument","unlisted":false},{"type":"link","label":"Get Document list from status","href":"/docs/API-docs/v1.1/getdocumentlist","className":"api-method get","docId":"API-docs/v1.1/getdocumentlist","unlisted":false},{"type":"link","label":"Resend request mail","href":"/docs/API-docs/v1.1/resendrequestmail","className":"api-method post","docId":"API-docs/v1.1/resendrequestmail","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","label":"Draft Template","href":"/docs/API-docs/v1.1/drafttemplate","className":"api-method post","docId":"API-docs/v1.1/drafttemplate","unlisted":false},{"type":"link","label":"Create Template","href":"/docs/API-docs/v1.1/createtemplate","className":"api-method post","docId":"API-docs/v1.1/createtemplate","unlisted":false},{"type":"link","label":"Public Template","href":"/docs/API-docs/v1.1/publictemplate","className":"api-method post","docId":"API-docs/v1.1/publictemplate","unlisted":false},{"type":"link","label":"Get Template","href":"/docs/API-docs/v1.1/get-template","className":"api-method get","docId":"API-docs/v1.1/get-template","unlisted":false},{"type":"link","label":"Update Template","href":"/docs/API-docs/v1.1/update-template","className":"api-method put","docId":"API-docs/v1.1/update-template","unlisted":false},{"type":"link","label":"Delete Template","href":"/docs/API-docs/v1.1/delete-template","className":"api-method delete","docId":"API-docs/v1.1/delete-template","unlisted":false},{"type":"link","label":"Get Template list","href":"/docs/API-docs/v1.1/gettemplatelist","className":"api-method get","docId":"API-docs/v1.1/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","label":"Get Webhook","href":"/docs/API-docs/v1.1/get-webhook","className":"api-method get","docId":"API-docs/v1.1/get-webhook","unlisted":false},{"type":"link","label":"Save or Update Webhook","href":"/docs/API-docs/v1.1/save-update-webhook","className":"api-method post","docId":"API-docs/v1.1/save-update-webhook","unlisted":false},{"type":"link","label":"Delete Webhook","href":"/docs/API-docs/v1.1/delete-webhook","className":"api-method delete","docId":"API-docs/v1.1/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Folder","items":[{"type":"link","label":"Create Folder","href":"/docs/API-docs/v1.1/createfolder","className":"api-method post","docId":"API-docs/v1.1/createfolder","unlisted":false},{"type":"link","label":"Get Folder","href":"/docs/API-docs/v1.1/getfolder","className":"api-method get","docId":"API-docs/v1.1/getfolder","unlisted":false},{"type":"link","label":"Update Folder","href":"/docs/API-docs/v1.1/updatefolder","className":"api-method put","docId":"API-docs/v1.1/updatefolder","unlisted":false},{"type":"link","label":"Delete Folder","href":"/docs/API-docs/v1.1/deletefolder","className":"api-method delete","docId":"API-docs/v1.1/deletefolder","unlisted":false},{"type":"link","label":"Get folder list","href":"/docs/API-docs/v1.1/folderlist","className":"api-method get","docId":"API-docs/v1.1/folderlist","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true,"href":"/docs/API-docs/v1.1"},{"type":"category","label":"v1","collapsed":true,"items":[{"type":"link","label":"Introduction","href":"/docs/API-docs/v1/opensign-api-v-1","docId":"API-docs/v1/opensign-api-v-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","label":"Get your account details","href":"/docs/API-docs/v1/get-user","className":"api-method get","docId":"API-docs/v1/get-user","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","label":"Create Contact","href":"/docs/API-docs/v1/createcontact","className":"api-method post","docId":"API-docs/v1/createcontact","unlisted":false},{"type":"link","label":"Get Contact","href":"/docs/API-docs/v1/getcontact","className":"api-method get","docId":"API-docs/v1/getcontact","unlisted":false},{"type":"link","label":"Delete Contact","href":"/docs/API-docs/v1/deletecontact","className":"api-method delete","docId":"API-docs/v1/deletecontact","unlisted":false},{"type":"link","label":"Get Contact list","href":"/docs/API-docs/v1/contactlist","className":"api-method get","docId":"API-docs/v1/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","label":"Self Sign","href":"/docs/API-docs/v1/selfsign","className":"api-method post","docId":"API-docs/v1/selfsign","unlisted":false},{"type":"link","label":"Draft Document","href":"/docs/API-docs/v1/draftdocument","className":"api-method post","docId":"API-docs/v1/draftdocument","unlisted":false},{"type":"link","label":"Create Document","href":"/docs/API-docs/v1/createdocument","className":"api-method post","docId":"API-docs/v1/createdocument","unlisted":false},{"type":"link","label":"Create Document from Template","href":"/docs/API-docs/v1/createdocumentwithtemplateid","className":"api-method post","docId":"API-docs/v1/createdocumentwithtemplateid","unlisted":false},{"type":"link","label":"Get Document","href":"/docs/API-docs/v1/getdocument","className":"api-method get","docId":"API-docs/v1/getdocument","unlisted":false},{"type":"link","label":"Update Document","href":"/docs/API-docs/v1/update-document","className":"api-method put","docId":"API-docs/v1/update-document","unlisted":false},{"type":"link","label":"Revoke Document","href":"/docs/API-docs/v1/revokedocument","className":"api-method post","docId":"API-docs/v1/revokedocument","unlisted":false},{"type":"link","label":"Delete Document","href":"/docs/API-docs/v1/deletedocument","className":"api-method delete","docId":"API-docs/v1/deletedocument","unlisted":false},{"type":"link","label":"Get Document list from status","href":"/docs/API-docs/v1/getdocumentlist","className":"api-method get","docId":"API-docs/v1/getdocumentlist","unlisted":false},{"type":"link","label":"Resend request mail","href":"/docs/API-docs/v1/resendrequestmail","className":"api-method post","docId":"API-docs/v1/resendrequestmail","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","label":"Draft Template","href":"/docs/API-docs/v1/drafttemplate","className":"api-method post","docId":"API-docs/v1/drafttemplate","unlisted":false},{"type":"link","label":"Create Template","href":"/docs/API-docs/v1/createtemplate","className":"api-method post","docId":"API-docs/v1/createtemplate","unlisted":false},{"type":"link","label":"Get Template","href":"/docs/API-docs/v1/get-template","className":"api-method get","docId":"API-docs/v1/get-template","unlisted":false},{"type":"link","label":"Update Template","href":"/docs/API-docs/v1/update-template","className":"api-method put","docId":"API-docs/v1/update-template","unlisted":false},{"type":"link","label":"Delete Template","href":"/docs/API-docs/v1/delete-template","className":"api-method delete","docId":"API-docs/v1/delete-template","unlisted":false},{"type":"link","label":"Get Template list","href":"/docs/API-docs/v1/gettemplatelist","className":"api-method get","docId":"API-docs/v1/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","label":"Get Webhook","href":"/docs/API-docs/v1/get-webhook","className":"api-method get","docId":"API-docs/v1/get-webhook","unlisted":false},{"type":"link","label":"Save or Update Webhook","href":"/docs/API-docs/v1/save-update-webhook","className":"api-method post","docId":"API-docs/v1/save-update-webhook","unlisted":false},{"type":"link","label":"Delete Webhook","href":"/docs/API-docs/v1/delete-webhook","className":"api-method delete","docId":"API-docs/v1/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Folder","items":[{"type":"link","label":"Create Folder","href":"/docs/API-docs/v1/createfolder","className":"api-method post","docId":"API-docs/v1/createfolder","unlisted":false},{"type":"link","label":"Get Folder","href":"/docs/API-docs/v1/getfolder","className":"api-method get","docId":"API-docs/v1/getfolder","unlisted":false},{"type":"link","label":"Update Folder","href":"/docs/API-docs/v1/updatefolder","className":"api-method put","docId":"API-docs/v1/updatefolder","unlisted":false},{"type":"link","label":"Delete Folder","href":"/docs/API-docs/v1/deletefolder","className":"api-method delete","docId":"API-docs/v1/deletefolder","unlisted":false},{"type":"link","label":"Get folder list","href":"/docs/API-docs/v1/folderlist","className":"api-method get","docId":"API-docs/v1/folderlist","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true,"href":"/docs/API-docs/v1"}]},"docs":{"API-docs/api-intro":{"id":"API-docs/api-intro","title":"OpenSign APIs","description":"Welcome to the OpenSign API. Choose a version from the sidebar:"},"API-docs/v1.1/contactlist":{"id":"API-docs/v1.1/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar":"apiSidebar"},"API-docs/v1.1/createcontact":{"id":"API-docs/v1.1/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar":"apiSidebar"},"API-docs/v1.1/createdocument":{"id":"API-docs/v1.1/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1.1/createdocumentwithtemplateid":{"id":"API-docs/v1.1/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar":"apiSidebar"},"API-docs/v1.1/createfolder":{"id":"API-docs/v1.1/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","sidebar":"apiSidebar"},"API-docs/v1.1/createtemplate":{"id":"API-docs/v1.1/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar":"apiSidebar"},"API-docs/v1.1/delete-template":{"id":"API-docs/v1.1/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar":"apiSidebar"},"API-docs/v1.1/delete-webhook":{"id":"API-docs/v1.1/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar":"apiSidebar"},"API-docs/v1.1/deletecontact":{"id":"API-docs/v1.1/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar":"apiSidebar"},"API-docs/v1.1/deletedocument":{"id":"API-docs/v1.1/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1.1/deletefolder":{"id":"API-docs/v1.1/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","sidebar":"apiSidebar"},"API-docs/v1.1/draftdocument":{"id":"API-docs/v1.1/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1.1/drafttemplate":{"id":"API-docs/v1.1/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar":"apiSidebar"},"API-docs/v1.1/folderlist":{"id":"API-docs/v1.1/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","sidebar":"apiSidebar"},"API-docs/v1.1/get-template":{"id":"API-docs/v1.1/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar":"apiSidebar"},"API-docs/v1.1/get-user":{"id":"API-docs/v1.1/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar":"apiSidebar"},"API-docs/v1.1/get-webhook":{"id":"API-docs/v1.1/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar":"apiSidebar"},"API-docs/v1.1/getcontact":{"id":"API-docs/v1.1/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar":"apiSidebar"},"API-docs/v1.1/getcredits":{"id":"API-docs/v1.1/getcredits","title":"Get your API credits","description":"The Get Credits API returns details about the credits available to your account:","sidebar":"apiSidebar"},"API-docs/v1.1/getdocument":{"id":"API-docs/v1.1/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar":"apiSidebar"},"API-docs/v1.1/getdocumentlist":{"id":"API-docs/v1.1/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/v1.1/getfolder":{"id":"API-docs/v1.1/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","sidebar":"apiSidebar"},"API-docs/v1.1/gettemplatelist":{"id":"API-docs/v1.1/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar":"apiSidebar"},"API-docs/v1.1/intro":{"id":"API-docs/v1.1/intro","title":"Overview","description":"OpenSign\u2122 API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures."},"API-docs/v1.1/opensign-api-v-1-1":{"id":"API-docs/v1.1/opensign-api-v-1-1","title":"OpenSign API v1.1","description":"Welcome to the **OpenSign\u2122 API v1.1** documentation.","sidebar":"apiSidebar"},"API-docs/v1.1/publictemplate":{"id":"API-docs/v1.1/publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","sidebar":"apiSidebar"},"API-docs/v1.1/resendrequestmail":{"id":"API-docs/v1.1/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","sidebar":"apiSidebar"},"API-docs/v1.1/revokedocument":{"id":"API-docs/v1.1/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1.1/save-update-webhook":{"id":"API-docs/v1.1/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar":"apiSidebar"},"API-docs/v1.1/selfsign":{"id":"API-docs/v1.1/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar":"apiSidebar"},"API-docs/v1.1/update-document":{"id":"API-docs/v1.1/update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","sidebar":"apiSidebar"},"API-docs/v1.1/update-template":{"id":"API-docs/v1.1/update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","sidebar":"apiSidebar"},"API-docs/v1.1/updatefolder":{"id":"API-docs/v1.1/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","sidebar":"apiSidebar"},"API-docs/v1/contactlist":{"id":"API-docs/v1/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar":"apiSidebar"},"API-docs/v1/createcontact":{"id":"API-docs/v1/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar":"apiSidebar"},"API-docs/v1/createdocument":{"id":"API-docs/v1/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1/createdocumentwithtemplateid":{"id":"API-docs/v1/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar":"apiSidebar"},"API-docs/v1/createfolder":{"id":"API-docs/v1/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","sidebar":"apiSidebar"},"API-docs/v1/createtemplate":{"id":"API-docs/v1/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar":"apiSidebar"},"API-docs/v1/delete-template":{"id":"API-docs/v1/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar":"apiSidebar"},"API-docs/v1/delete-webhook":{"id":"API-docs/v1/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar":"apiSidebar"},"API-docs/v1/deletecontact":{"id":"API-docs/v1/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar":"apiSidebar"},"API-docs/v1/deletedocument":{"id":"API-docs/v1/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1/deletefolder":{"id":"API-docs/v1/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","sidebar":"apiSidebar"},"API-docs/v1/draftdocument":{"id":"API-docs/v1/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1/drafttemplate":{"id":"API-docs/v1/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar":"apiSidebar"},"API-docs/v1/folderlist":{"id":"API-docs/v1/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","sidebar":"apiSidebar"},"API-docs/v1/get-template":{"id":"API-docs/v1/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar":"apiSidebar"},"API-docs/v1/get-user":{"id":"API-docs/v1/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar":"apiSidebar"},"API-docs/v1/get-webhook":{"id":"API-docs/v1/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar":"apiSidebar"},"API-docs/v1/getcontact":{"id":"API-docs/v1/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar":"apiSidebar"},"API-docs/v1/getdocument":{"id":"API-docs/v1/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar":"apiSidebar"},"API-docs/v1/getdocumentlist":{"id":"API-docs/v1/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/v1/getfolder":{"id":"API-docs/v1/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","sidebar":"apiSidebar"},"API-docs/v1/gettemplatelist":{"id":"API-docs/v1/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar":"apiSidebar"},"API-docs/v1/intro":{"id":"API-docs/v1/intro","title":"Overview","description":"OpenSign\u2122 API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures."},"API-docs/v1/opensign-api-v-1":{"id":"API-docs/v1/opensign-api-v-1","title":"OpenSign API v1","description":"Welcome to the OpenSign\u2122 API documentation!","sidebar":"apiSidebar"},"API-docs/v1/resendrequestmail":{"id":"API-docs/v1/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","sidebar":"apiSidebar"},"API-docs/v1/revokedocument":{"id":"API-docs/v1/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1/save-update-webhook":{"id":"API-docs/v1/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar":"apiSidebar"},"API-docs/v1/selfsign":{"id":"API-docs/v1/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar":"apiSidebar"},"API-docs/v1/update-document":{"id":"API-docs/v1/update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","sidebar":"apiSidebar"},"API-docs/v1/update-template":{"id":"API-docs/v1/update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","sidebar":"apiSidebar"},"API-docs/v1/updatefolder":{"id":"API-docs/v1/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","sidebar":"apiSidebar"},"contribute/CODE_OF_CONDUCT":{"id":"contribute/CODE_OF_CONDUCT","title":"Code of conduct","description":"1. Introduction","sidebar":"contributeSidebar"},"contribute/COMMUNITY":{"id":"contribute/COMMUNITY","title":"Community at OpenSign\u2122","description":"Welcome to the OpenSign\u2122 Community page! OpenSign\u2122 is dedicated to fostering a vibrant and engaging community where members can connect, share ideas and collaborate on the OpenSign\u2122 project. This page provides links to our active social media platforms and community channels, offering various ways for you to join and participate in the OpenSign\u2122 community. Whether you\'re looking for support, eager to contribute or just want to stay updated, you\'ll find a platform that suits your preference. Connect with us on Discord for real-time discussions, follow us on Twitter for the latest updates, engage with our professional network on LinkedIn or join our Facebook group for a broader community experience. Join us in our mission to develop OpenSign\u2122 as the premier open-source alternative to DocuSign.","sidebar":"contributeSidebar"},"contribute/INSTALLATION":{"id":"contribute/INSTALLATION","title":"Installation instructions","description":"You can use our app as a cloud version from OpenSignLabs","sidebar":"contributeSidebar"},"contribute/intro":{"id":"contribute/intro","title":"Contributing to OpenSign","description":"Hello there! Thank you for considering contributing to OpenSign, the open-source alternative to DocuSign. OpenSign is not just a project, but a community endeavor that aims to create a robust, user-friendly, and secure electronic signature solution. Your contributions, irrespective of their size, are valuable in making this vision a reality.","sidebar":"contributeSidebar"},"contribute/REPORTING_GUIDELINES":{"id":"contribute/REPORTING_GUIDELINES","title":"OpenSign\u2122 Reporting Guidelines","description":"This document provides guidelines for reporting issues, suggesting enhancements, and submitting pull requests to the OpenSign\u2122 GitHub repository. Adhering to these guidelines helps maintain the project\'s quality and efficiency.","sidebar":"contributeSidebar"},"help/FAQs/Ensure this field is accurately filled and meets all requirements":{"id":"help/FAQs/Ensure this field is accurately filled and meets all requirements","title":"Why am I getting \'Ensure this field is accurately filled and meets all requirements\'?","description":"This happens when you leave a field blank or when you don\u2019t enter correct values in the field, for example not entering email address in correct format.","sidebar":"tutorialSidebar"},"help/FAQs/FAQs":{"id":"help/FAQs/FAQs","title":"Why is there no dropdown list when I sign a document myself?","description":"The dropdown list field is available only when you request a signature from others or when you create a template. This is because dropdown lists function as temporary widgets, allowing the user to select one of multiple values. Once a signer selects a value from the dropdown, it is embedded into the document as text. When you sign a document yourself, OpenSign digitally signs it immediately upon clicking the finish button. Therefore, you can use the text widget to add the necessary text to the document.","sidebar":"tutorialSidebar"},"help/FAQs/Max File Upload Size":{"id":"help/FAQs/Max File Upload Size","title":"Max File Upload Size","description":"\u2753 What is the default maximum file size that can be uploaded to OpenSign?","sidebar":"tutorialSidebar"},"help/FAQs/User Deletion":{"id":"help/FAQs/User Deletion","title":"User Deletion","description":"\u2753 Who can delete users?","sidebar":"tutorialSidebar"},"help/intro":{"id":"help/intro","title":"Intro","description":"\ud83c\udf1fGet ready for an electrifying journey at OpenSign\u2122, the most incredibly documented open source document signing solution! \ud83d\ude80 This is your go-to spot for diving deep into everything OpenSign\u2122 has to offer. Whether you\u2019re just starting out or you\u2019re a seasoned pro eager to uncover even more cool features, we\u2019ve got you covered with the most awesome, top-notch guides and resources around. Get ready to make the most out of OpenSign\u2122 \ud83c\udf89\ud83d\udcda\ud83d\udd0d Your adventure in excellence starts here! \ud83c\udf08\u2728\ud83c\udf1f","sidebar":"tutorialSidebar"},"help/New-Document/edit-document-before-sending":{"id":"help/New-Document/edit-document-before-sending","title":"Editing Your Document Before Sending","description":"OpenSign\u2122 lets you polish your PDF before you send it out\u2014whether you\u2019re signing it yourself, requesting signatures, or saving it as a template. You get four core editing controls right in the preview:","sidebar":"tutorialSidebar"},"help/New-Document/enforce-email-verification":{"id":"help/New-Document/enforce-email-verification","title":"Enforce email OTP verification","description":"The \\"Enable OTP Verification\\" feature in OpenSign is designed to add an extra layer of security to the document-signing process by verifying the signer\u2019s email address. Here\u2019s an in-depth look at how it works, when to use it, and its impact on the signing process.","sidebar":"tutorialSidebar"},"help/New-Document/request-signatures":{"id":"help/New-Document/request-signatures","title":"Request signatures","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/New-Document/sign-yourself":{"id":"help/New-Document/sign-yourself","title":"Sign your-self","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/New-Document/widgets":{"id":"help/New-Document/widgets","title":"Widgets in OpenSign","description":"Widgets in OpenSign are interactive fields that you can place on your documents to collect information, signatures, or confirmations from recipients during the signing process.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/create-document":{"id":"help/OpenSign\u2122 Drive/create-document","title":"Create Docs & Folders","description":"OpenSign Drive offers a streamlined way to manage, sign, and request signatures on your important documents. Whether you\'re drafting an offer letter or storing signed agreements, organizing your documents effectively is crucial. Here\u2019s a step-by-step guide on how to create documents and folders in OpenSign Drive.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/list-grid-view":{"id":"help/OpenSign\u2122 Drive/list-grid-view","title":"Grid vs List view","description":"- Navigate to OpenSign drive using the main menu or clicking this link.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/organize-documents":{"id":"help/OpenSign\u2122 Drive/organize-documents","title":"OpenSign\u2122 Drive Interface Documentation","description":"Overview","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/rename-document":{"id":"help/OpenSign\u2122 Drive/rename-document","title":"Rename documents from OpenSign\u2122 Drive","description":"The OpenSign\u2122 Drive interface allows users to rename their documents efficiently.","sidebar":"tutorialSidebar"},"help/Reports/completed":{"id":"help/Reports/completed","title":"Completed","description":"---","sidebar":"tutorialSidebar"},"help/Reports/contactbook":{"id":"help/Reports/contactbook","title":"Contactbook","description":"The Contactbook report in OpenSign enables you to add and manage contacts.","sidebar":"tutorialSidebar"},"help/Reports/declined":{"id":"help/Reports/declined","title":"Declined","description":"The \\"Declined documents\\" report within OpenSign serves as a vital tool for managing and reviewing all declined documents that have been processed through the platform. This guide will walk you through the key features and functionalities of the \\"Declined documents\\" report, enabling you to efficiently navigate and manage your signed documents.","sidebar":"tutorialSidebar"},"help/Reports/drafts":{"id":"help/Reports/drafts","title":"Drafts","description":"The Draft documents section in OpenSign helps you manage all your in-progress documents easily. This feature allows you to save, review, and edit documents before sending them for signature. Here\'s a detailed overview of how to navigate and use the Draft Documents report effectively.","sidebar":"tutorialSidebar"},"help/Reports/expired":{"id":"help/Reports/expired","title":"Expired","description":"The Expired documents report in OpenSign allows you to manage and review documents that have reached their expiration date without being signed. This feature is essential for maintaining an organized record of inactive documents that may require follow-up or archival.","sidebar":"tutorialSidebar"},"help/Reports/in-progress":{"id":"help/Reports/in-progress","title":"In Progress","description":"The In-Progress documents report in OpenSign helps you monitor and manage documents that are currently in the signing process. This report enables you to monitor the status of your documents, manually share the document URL, track document progress, resend reminders, revoke access, or delete documents that are no longer required. Here\u2019s a detailed guide on how to use the In-Progress documents report effectively.","sidebar":"tutorialSidebar"},"help/Reports/need-your-sign":{"id":"help/Reports/need-your-sign","title":"Need your sign","description":"The \\"Need your sign\\" feature in OpenSign is designed to simplify the process of managing documents that require your signature. This guide will walk you through the various elements of the \\"Need your sign\\" report, helping you to efficiently navigate and complete your pending signing tasks.","sidebar":"tutorialSidebar"},"help/Settings/APIToken":{"id":"help/Settings/APIToken","title":"API Token","description":"To authenticate and use OpenSign API endpoints, you\u2019ll need a valid API token (x-api-token).","sidebar":"tutorialSidebar"},"help/Settings/Custom-email-templates":{"id":"help/Settings/Custom-email-templates","title":"Custom email templates","description":"\ud83d\ude80 Steps to Set Up Custom Email Templates","sidebar":"tutorialSidebar"},"help/Settings/disabledocumentid":{"id":"help/Settings/disabledocumentid","title":"Disable DocumentId","description":"Whenever a document is signed by all parties, OpenSign\u2122 adds a DocumentId at the top left corner of the digitally signed document.","sidebar":"tutorialSidebar"},"help/Settings/manage-users":{"id":"help/Settings/manage-users","title":"Manage users","description":"The User Management feature in OpenSign allows administrators to add, edit, and manage users within the platform. This functionality is available on Self-Hosted, Teams, and Enterprise plans.","sidebar":"tutorialSidebar"},"help/Settings/my-signature":{"id":"help/Settings/my-signature","title":"My Signature","description":"This guide provides instructions on how to save your signature and initials using the OpenSign application. Once saved, you can use them with one click when signing documents. To create your signature, start by clicking the \\"My Signature\\" link under \\"settings\\" menu.","sidebar":"tutorialSidebar"},"help/Settings/Preferences":{"id":"help/Settings/Preferences","title":"Preferences","description":"The Preferences page in OpenSign\u2122 allows users and administrators to tailor the signing experience to suit individual, team, or organizational needs. Below is a breakdown of all configurable options and what they control.","sidebar":"tutorialSidebar"},"help/Settings/SecurityManagement":{"id":"help/Settings/SecurityManagement","title":"Security","description":"\u2705 Two-Factor Authentication (2FA)","sidebar":"tutorialSidebar"},"help/Settings/Teams":{"id":"help/Settings/Teams","title":"Manage Teams","description":"The Teams feature in OpenSign allows you to organize your users into structured groups for easier management, permissions control, and streamlined workflow configuration.","sidebar":"tutorialSidebar"},"help/Settings/Webhook":{"id":"help/Settings/Webhook","title":"Webhook","description":"\ud83d\udd14 What is a Webhook?","sidebar":"tutorialSidebar"},"help/Templates/create-template":{"id":"help/Templates/create-template","title":"Create Templates","description":"Getting Started","sidebar":"tutorialSidebar"},"help/Templates/embed-template":{"id":"help/Templates/embed-template","title":"Embedding OpenSign templates","description":"OpenSign Template Embedding allows users to seamlessly integrate public document templates into their websites or applications. By embedding templates, you can provide a direct and interactive signing experience for your users without requiring them to leave your platform. This feature supports various technologies like React, Next.js, HTML, JavaScript, and Angular, making it easy to add signing capabilities to different web projects.","sidebar":"tutorialSidebar"},"help/Templates/manage-templates":{"id":"help/Templates/manage-templates","title":"Manage Templates","description":"Viewing and Managing Templates","sidebar":"tutorialSidebar"},"help/Templates/publicTemplate":{"id":"help/Templates/publicTemplate","title":"Setting up an OpenSign template for public signing","description":"The OpenSign Public profile feature offers the ultimate public document signing solution without any need for integrations. With this feature, users can share document templates publicly, allowing anyone to access and sign the documents directly through the shared templates. This streamlines the signing process by providing a seamless, accessible way for public signers to complete documents without additional steps or integrations.","sidebar":"tutorialSidebar"},"help/Templates/quick-send":{"id":"help/Templates/quick-send","title":"Quickly Send the Document for Signature Using Template","description":"Step 1: Begin New Template Creation","sidebar":"tutorialSidebar"},"help/Templates/use-template":{"id":"help/Templates/use-template","title":"Use template to create documents","description":"Step 1: Begin New Template Creation","sidebar":"tutorialSidebar"},"help/User Menu/Console/analystics":{"id":"help/User Menu/Console/analystics","title":"Analytics","description":"Documents Signed","sidebar":"tutorialSidebar"},"help/User Menu/Console/branding":{"id":"help/User Menu/Console/branding","title":"Branding","description":"Custom Subdomain","sidebar":"tutorialSidebar"},"help/User Menu/Console/custom_filestorage":{"id":"help/User Menu/Console/custom_filestorage","title":"Custom File Storage","description":"\ud83c\udf29\ufe0f Introduction to BYOC (Bring Your Own Cloud)","sidebar":"tutorialSidebar"},"help/User Menu/Console/emails":{"id":"help/User Menu/Console/emails","title":"Email Templates","description":"This page allows the admin user to configure and manage customized email templates at the organization level.","sidebar":"tutorialSidebar"},"help/User Menu/Console/general":{"id":"help/User Menu/Console/general","title":"General","description":"The General Settings section in OpenSign provides key administrative settings to help you manage and control the overall configuration of your OpenSign platform.","sidebar":"tutorialSidebar"},"help/User Menu/Console/orgadmin":{"id":"help/User Menu/Console/orgadmin","title":"Org Admins","description":"The Org Admins section allows administrators to manage organization-level admin users within OpenSign.","sidebar":"tutorialSidebar"},"help/User Menu/Console/organizations":{"id":"help/User Menu/Console/organizations","title":"Organizations","description":"The Organizations section in OpenSign allows administrators to create and manage separate groups within a Team or Enterprise account.","sidebar":"tutorialSidebar"},"help/User Menu/Console/signing_certificate":{"id":"help/User Menu/Console/signing_certificate","title":"Custom Signing Certificate","description":"The Custom Signing Certificate page allows you to upload and manage your own digital signing certificate (PFX format) for secure and verified document signing in OpenSign.","sidebar":"tutorialSidebar"},"help/User Menu/Profile":{"id":"help/User Menu/Profile","title":"Profile","description":"The Profile in OpenSign allows users to manage their personal and account-related details. You can update your information, verify your email, and set up a public profile.","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Tutorial Intro","description":"Let\'s discover Docusaurus in less than 5 minutes."},"self-host/cloud-storage/s3":{"id":"self-host/cloud-storage/s3","title":"AWS S3","description":"You can create an AWS S3 bucket to store your uploaded documents using OpenSign\u2122","sidebar":"selfhostSidebar"},"self-host/docker/run-locally":{"id":"self-host/docker/run-locally","title":"Self-host OpenSign\u2122 with Docker on Linux/MacOS/Windows","description":"Steps to run OpenSign\u2122 with docker on Linux/MacOS/Windows:","sidebar":"selfhostSidebar"},"self-host/docker/upgrade-deployment":{"id":"self-host/docker/upgrade-deployment","title":"OpenSign\u2122 Self-Hosted \'Upgrade Deployment\' Guide Using Docker on Linux, macOS, or Windows","description":"This guide provides step-by-step instructions to upgrade the deployment of OpenSign using Docker.","sidebar":"selfhostSidebar"},"self-host/guides/azure-vm-setup":{"id":"self-host/guides/azure-vm-setup","title":"OpenSign Deployment Guide on Azure VM via command-line","description":"\ud83e\uddf1 Prerequisites","sidebar":"selfhostSidebar"},"self-host/guides/env-variables":{"id":"self-host/guides/env-variables","title":"ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","description":"Information About ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","sidebar":"selfhostSidebar"},"self-host/guides/how-to-generate-self-signed-document-signing-certificate":{"id":"self-host/guides/how-to-generate-self-signed-document-signing-certificate","title":"How to generate self-signed document signing certificate?","description":"","sidebar":"selfhostSidebar"},"self-host/guides/upgrade-to-v2.1.0":{"id":"self-host/guides/upgrade-to-v2.1.0","title":"How to upgrade self-hosted OpenSign to v2.1.0?","description":"For self-hosted deployments, version 2.1.0 introduces changes to the signup process:","sidebar":"selfhostSidebar"},"self-host/intro":{"id":"self-host/intro","title":"Self-Hosting OpenSign","description":"This section of the OpenSign\u2122 documentation is dedicated to guiding you through the process of self-hosting the OpenSign platform. Self-hosting OpenSign allows for greater control and customization, ensuring that it aligns perfectly with your specific needs and infrastructure requirements. We cover everything from initial setup, configuration options, to maintenance best practices. Whether you are an individual enthusiast or a professional looking to deploy OpenSign in a corporate environment, this guide will provide you with the necessary steps and tips to successfully self-host OpenSign\u2122 - the best open source document signing infrastructure.","sidebar":"selfhostSidebar"},"self-host/One-click-Install/DigitalOcean":{"id":"self-host/One-click-Install/DigitalOcean","title":"Digital Ocean","description":"OpenSign application consists of 3 components -","sidebar":"selfhostSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/0058b4c6.ddb4bff2.js b/assets/js/0058b4c6.ddb4bff2.js new file mode 100644 index 000000000..2f2c860a6 --- /dev/null +++ b/assets/js/0058b4c6.ddb4bff2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[849],{86164:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Intro","href":"/docs/help/intro","docId":"help/intro","unlisted":false},{"type":"category","label":"Create New OpenSign Document","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Sign your-self","href":"/docs/help/New-Document/sign-yourself","docId":"help/New-Document/sign-yourself","unlisted":false},{"type":"link","label":"Request signatures","href":"/docs/help/New-Document/request-signatures","docId":"help/New-Document/request-signatures","unlisted":false},{"type":"link","label":"Widgets in OpenSign","href":"/docs/help/New-Document/widgets","docId":"help/New-Document/widgets","unlisted":false},{"type":"link","label":"Editing Your Document Before Sending","href":"/docs/help/New-Document/edit-document-before-sending","docId":"help/New-Document/edit-document-before-sending","unlisted":false},{"type":"link","label":"Enforce email OTP verification","href":"/docs/help/New-Document/enforce-email-verification","docId":"help/New-Document/enforce-email-verification","unlisted":false}],"href":"/docs/category/create-new-opensign-document"},{"type":"category","label":"Manage Docs using OpenSign\u2122 Drive","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Docs & Folders","href":"/docs/help/OpenSign\u2122 Drive/create-document","docId":"help/OpenSign\u2122 Drive/create-document","unlisted":false},{"type":"link","label":"Grid vs List view","href":"/docs/help/OpenSign\u2122 Drive/list-grid-view","docId":"help/OpenSign\u2122 Drive/list-grid-view","unlisted":false},{"type":"link","label":"OpenSign\u2122 Drive Interface Documentation","href":"/docs/help/OpenSign\u2122 Drive/organize-documents","docId":"help/OpenSign\u2122 Drive/organize-documents","unlisted":false},{"type":"link","label":"Rename documents from OpenSign\u2122 Drive","href":"/docs/help/OpenSign\u2122 Drive/rename-document","docId":"help/OpenSign\u2122 Drive/rename-document","unlisted":false}],"href":"/docs/category/manage-docs-using-opensign-drive"},{"type":"category","label":"Documents","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Need your sign","href":"/docs/help/Reports/need-your-sign","docId":"help/Reports/need-your-sign","unlisted":false},{"type":"link","label":"In Progress","href":"/docs/help/Reports/in-progress","docId":"help/Reports/in-progress","unlisted":false},{"type":"link","label":"Completed","href":"/docs/help/Reports/completed","docId":"help/Reports/completed","unlisted":false},{"type":"link","label":"Drafts","href":"/docs/help/Reports/drafts","docId":"help/Reports/drafts","unlisted":false},{"type":"link","label":"Declined","href":"/docs/help/Reports/declined","docId":"help/Reports/declined","unlisted":false},{"type":"link","label":"Expired","href":"/docs/help/Reports/expired","docId":"help/Reports/expired","unlisted":false},{"type":"link","label":"Contactbook","href":"/docs/help/Reports/contactbook","docId":"help/Reports/contactbook","unlisted":false}],"href":"/docs/category/documents"},{"type":"category","label":"Templates","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Templates","href":"/docs/help/Templates/create-template","docId":"help/Templates/create-template","unlisted":false},{"type":"link","label":"Manage Templates","href":"/docs/help/Templates/manage-templates","docId":"help/Templates/manage-templates","unlisted":false},{"type":"link","label":"Use template to create documents","href":"/docs/help/Templates/use-template","docId":"help/Templates/use-template","unlisted":false},{"type":"link","label":"Quickly Send the Document for Signature Using Template","href":"/docs/help/Templates/quick-send","docId":"help/Templates/quick-send","unlisted":false},{"type":"link","label":"Setting up an OpenSign template for public signing","href":"/docs/help/Templates/publicTemplate","docId":"help/Templates/publicTemplate","unlisted":false},{"type":"link","label":"Embedding OpenSign templates","href":"/docs/help/Templates/embed-template","docId":"help/Templates/embed-template","unlisted":false}],"href":"/docs/category/templates"},{"type":"category","label":"Settings","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"My Signature","href":"/docs/help/Settings/my-signature","docId":"help/Settings/my-signature","unlisted":false},{"type":"link","label":"API Token","href":"/docs/help/Settings/APIToken","docId":"help/Settings/APIToken","unlisted":false},{"type":"link","label":"Webhook","href":"/docs/help/Settings/Webhook","docId":"help/Settings/Webhook","unlisted":false},{"type":"link","label":"Preferences","href":"/docs/help/Settings/Preferences","docId":"help/Settings/Preferences","unlisted":false},{"type":"link","label":"Manage Teams","href":"/docs/help/Settings/Teams","docId":"help/Settings/Teams","unlisted":false},{"type":"link","label":"Manage users","href":"/docs/help/Settings/manage-users","docId":"help/Settings/manage-users","unlisted":false},{"type":"link","label":"Disable DocumentId","href":"/docs/help/Settings/disabledocumentid","docId":"help/Settings/disabledocumentid","unlisted":false},{"type":"link","label":"Custom email templates","href":"/docs/help/Settings/Custom-email-templates","docId":"help/Settings/Custom-email-templates","unlisted":false},{"type":"link","label":"Security","href":"/docs/help/Settings/SecurityManagement","docId":"help/Settings/SecurityManagement","unlisted":false}],"href":"/docs/category/settings"},{"type":"category","label":"User Menu","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Profile","href":"/docs/help/User Menu/Profile","docId":"help/User Menu/Profile","unlisted":false},{"type":"category","label":"Console","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Analytics","href":"/docs/help/User Menu/Console/analystics","docId":"help/User Menu/Console/analystics","unlisted":false},{"type":"link","label":"General","href":"/docs/help/User Menu/Console/general","docId":"help/User Menu/Console/general","unlisted":false},{"type":"link","label":"Branding","href":"/docs/help/User Menu/Console/branding","docId":"help/User Menu/Console/branding","unlisted":false},{"type":"link","label":"Preferences","href":"/docs/help/User Menu/Console/globalSMTP","docId":"help/User Menu/Console/globalSMTP","unlisted":false},{"type":"link","label":"Custom File Storage","href":"/docs/help/User Menu/Console/custom_filestorage","docId":"help/User Menu/Console/custom_filestorage","unlisted":false},{"type":"link","label":"Email Templates","href":"/docs/help/User Menu/Console/emails","docId":"help/User Menu/Console/emails","unlisted":false},{"type":"link","label":"Custom Signing Certificate","href":"/docs/help/User Menu/Console/signing_certificate","docId":"help/User Menu/Console/signing_certificate","unlisted":false},{"type":"link","label":"Organizations","href":"/docs/help/User Menu/Console/organizations","docId":"help/User Menu/Console/organizations","unlisted":false},{"type":"link","label":"Org Admins","href":"/docs/help/User Menu/Console/orgadmin","docId":"help/User Menu/Console/orgadmin","unlisted":false}],"href":"/docs/category/console"}],"href":"/docs/category/user-menu"},{"type":"category","label":"FAQs","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Why is there no dropdown list when I sign a document myself?","href":"/docs/help/FAQs/","docId":"help/FAQs/FAQs","unlisted":false},{"type":"link","label":"Why am I getting \'Ensure this field is accurately filled and meets all requirements\'?","href":"/docs/help/FAQs/Ensure this field is accurately filled and meets all requirements","docId":"help/FAQs/Ensure this field is accurately filled and meets all requirements","unlisted":false},{"type":"link","label":"Max File Upload Size","href":"/docs/help/FAQs/Max File Upload Size","docId":"help/FAQs/Max File Upload Size","unlisted":false},{"type":"link","label":"User Deletion","href":"/docs/help/FAQs/User Deletion","docId":"help/FAQs/User Deletion","unlisted":false}],"href":"/docs/category/faqs"}],"selfhostSidebar":[{"type":"link","label":"Self-Hosting OpenSign","href":"/docs/self-host/intro","docId":"self-host/intro","unlisted":false},{"type":"category","label":"Docker","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Self-host OpenSign\u2122 with Docker on Linux/MacOS/Windows","href":"/docs/self-host/docker/run-locally","docId":"self-host/docker/run-locally","unlisted":false},{"type":"link","label":"OpenSign\u2122 Self-Hosted \'Upgrade Deployment\' Guide Using Docker on Linux, macOS, or Windows","href":"/docs/self-host/docker/upgrade-deployment","docId":"self-host/docker/upgrade-deployment","unlisted":false}],"href":"/docs/category/docker"},{"type":"category","label":"Cloud Storage","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"AWS S3","href":"/docs/self-host/cloud-storage/s3","docId":"self-host/cloud-storage/s3","unlisted":false}],"href":"/docs/category/cloud-storage"},{"type":"category","label":"Guides","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"OpenSign Deployment Guide on Azure VM via command-line","href":"/docs/self-host/guides/azure-vm-setup","docId":"self-host/guides/azure-vm-setup","unlisted":false},{"type":"link","label":"ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","href":"/docs/self-host/guides/env-variables","docId":"self-host/guides/env-variables","unlisted":false},{"type":"link","label":"How to generate self-signed document signing certificate?","href":"/docs/self-host/guides/how-to-generate-self-signed-document-signing-certificate","docId":"self-host/guides/how-to-generate-self-signed-document-signing-certificate","unlisted":false},{"type":"link","label":"How to upgrade self-hosted OpenSign to v2.1.0?","href":"/docs/self-host/guides/upgrade-to-v2.1.0","docId":"self-host/guides/upgrade-to-v2.1.0","unlisted":false}],"href":"/docs/category/guides"},{"type":"category","label":"One-click-Install","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Digital Ocean","href":"/docs/self-host/One-click-Install/DigitalOcean","docId":"self-host/One-click-Install/DigitalOcean","unlisted":false}]}],"contributeSidebar":[{"type":"link","label":"Code of conduct","href":"/docs/contribute/CODE_OF_CONDUCT","docId":"contribute/CODE_OF_CONDUCT","unlisted":false},{"type":"link","label":"Contributing to OpenSign","href":"/docs/contribute/intro","docId":"contribute/intro","unlisted":false},{"type":"link","label":"Installation instructions","href":"/docs/contribute/INSTALLATION","docId":"contribute/INSTALLATION","unlisted":false},{"type":"link","label":"Community at OpenSign\u2122","href":"/docs/contribute/COMMUNITY","docId":"contribute/COMMUNITY","unlisted":false},{"type":"link","label":"OpenSign\u2122 Reporting Guidelines","href":"/docs/contribute/REPORTING_GUIDELINES","docId":"contribute/REPORTING_GUIDELINES","unlisted":false}],"apiSidebar":[{"type":"category","label":"v1.1","collapsed":false,"items":[{"type":"link","label":"Introduction","href":"/docs/API-docs/v1.1/opensign-api-v-1-1","docId":"API-docs/v1.1/opensign-api-v-1-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","label":"Get your account details","href":"/docs/API-docs/v1.1/get-user","className":"api-method get","docId":"API-docs/v1.1/get-user","unlisted":false},{"type":"link","label":"Get your API credits","href":"/docs/API-docs/v1.1/getcredits","className":"api-method get","docId":"API-docs/v1.1/getcredits","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","label":"Create Contact","href":"/docs/API-docs/v1.1/createcontact","className":"api-method post","docId":"API-docs/v1.1/createcontact","unlisted":false},{"type":"link","label":"Get Contact","href":"/docs/API-docs/v1.1/getcontact","className":"api-method get","docId":"API-docs/v1.1/getcontact","unlisted":false},{"type":"link","label":"Delete Contact","href":"/docs/API-docs/v1.1/deletecontact","className":"api-method delete","docId":"API-docs/v1.1/deletecontact","unlisted":false},{"type":"link","label":"Get Contact list","href":"/docs/API-docs/v1.1/contactlist","className":"api-method get","docId":"API-docs/v1.1/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","label":"Self Sign","href":"/docs/API-docs/v1.1/selfsign","className":"api-method post","docId":"API-docs/v1.1/selfsign","unlisted":false},{"type":"link","label":"Draft Document","href":"/docs/API-docs/v1.1/draftdocument","className":"api-method post","docId":"API-docs/v1.1/draftdocument","unlisted":false},{"type":"link","label":"Create Document","href":"/docs/API-docs/v1.1/createdocument","className":"api-method post","docId":"API-docs/v1.1/createdocument","unlisted":false},{"type":"link","label":"Create Document from Template","href":"/docs/API-docs/v1.1/createdocumentwithtemplateid","className":"api-method post","docId":"API-docs/v1.1/createdocumentwithtemplateid","unlisted":false},{"type":"link","label":"Get Document","href":"/docs/API-docs/v1.1/getdocument","className":"api-method get","docId":"API-docs/v1.1/getdocument","unlisted":false},{"type":"link","label":"Update Document","href":"/docs/API-docs/v1.1/update-document","className":"api-method put","docId":"API-docs/v1.1/update-document","unlisted":false},{"type":"link","label":"Revoke Document","href":"/docs/API-docs/v1.1/revokedocument","className":"api-method post","docId":"API-docs/v1.1/revokedocument","unlisted":false},{"type":"link","label":"Delete Document","href":"/docs/API-docs/v1.1/deletedocument","className":"api-method delete","docId":"API-docs/v1.1/deletedocument","unlisted":false},{"type":"link","label":"Get Document list from status","href":"/docs/API-docs/v1.1/getdocumentlist","className":"api-method get","docId":"API-docs/v1.1/getdocumentlist","unlisted":false},{"type":"link","label":"Resend request mail","href":"/docs/API-docs/v1.1/resendrequestmail","className":"api-method post","docId":"API-docs/v1.1/resendrequestmail","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","label":"Draft Template","href":"/docs/API-docs/v1.1/drafttemplate","className":"api-method post","docId":"API-docs/v1.1/drafttemplate","unlisted":false},{"type":"link","label":"Create Template","href":"/docs/API-docs/v1.1/createtemplate","className":"api-method post","docId":"API-docs/v1.1/createtemplate","unlisted":false},{"type":"link","label":"Public Template","href":"/docs/API-docs/v1.1/publictemplate","className":"api-method post","docId":"API-docs/v1.1/publictemplate","unlisted":false},{"type":"link","label":"Get Template","href":"/docs/API-docs/v1.1/get-template","className":"api-method get","docId":"API-docs/v1.1/get-template","unlisted":false},{"type":"link","label":"Update Template","href":"/docs/API-docs/v1.1/update-template","className":"api-method put","docId":"API-docs/v1.1/update-template","unlisted":false},{"type":"link","label":"Delete Template","href":"/docs/API-docs/v1.1/delete-template","className":"api-method delete","docId":"API-docs/v1.1/delete-template","unlisted":false},{"type":"link","label":"Get Template list","href":"/docs/API-docs/v1.1/gettemplatelist","className":"api-method get","docId":"API-docs/v1.1/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","label":"Get Webhook","href":"/docs/API-docs/v1.1/get-webhook","className":"api-method get","docId":"API-docs/v1.1/get-webhook","unlisted":false},{"type":"link","label":"Save or Update Webhook","href":"/docs/API-docs/v1.1/save-update-webhook","className":"api-method post","docId":"API-docs/v1.1/save-update-webhook","unlisted":false},{"type":"link","label":"Delete Webhook","href":"/docs/API-docs/v1.1/delete-webhook","className":"api-method delete","docId":"API-docs/v1.1/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Folder","items":[{"type":"link","label":"Create Folder","href":"/docs/API-docs/v1.1/createfolder","className":"api-method post","docId":"API-docs/v1.1/createfolder","unlisted":false},{"type":"link","label":"Get Folder","href":"/docs/API-docs/v1.1/getfolder","className":"api-method get","docId":"API-docs/v1.1/getfolder","unlisted":false},{"type":"link","label":"Update Folder","href":"/docs/API-docs/v1.1/updatefolder","className":"api-method put","docId":"API-docs/v1.1/updatefolder","unlisted":false},{"type":"link","label":"Delete Folder","href":"/docs/API-docs/v1.1/deletefolder","className":"api-method delete","docId":"API-docs/v1.1/deletefolder","unlisted":false},{"type":"link","label":"Get folder list","href":"/docs/API-docs/v1.1/folderlist","className":"api-method get","docId":"API-docs/v1.1/folderlist","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true,"href":"/docs/API-docs/v1.1"},{"type":"category","label":"v1","collapsed":true,"items":[{"type":"link","label":"Introduction","href":"/docs/API-docs/v1/opensign-api-v-1","docId":"API-docs/v1/opensign-api-v-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","label":"Get your account details","href":"/docs/API-docs/v1/get-user","className":"api-method get","docId":"API-docs/v1/get-user","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","label":"Create Contact","href":"/docs/API-docs/v1/createcontact","className":"api-method post","docId":"API-docs/v1/createcontact","unlisted":false},{"type":"link","label":"Get Contact","href":"/docs/API-docs/v1/getcontact","className":"api-method get","docId":"API-docs/v1/getcontact","unlisted":false},{"type":"link","label":"Delete Contact","href":"/docs/API-docs/v1/deletecontact","className":"api-method delete","docId":"API-docs/v1/deletecontact","unlisted":false},{"type":"link","label":"Get Contact list","href":"/docs/API-docs/v1/contactlist","className":"api-method get","docId":"API-docs/v1/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","label":"Self Sign","href":"/docs/API-docs/v1/selfsign","className":"api-method post","docId":"API-docs/v1/selfsign","unlisted":false},{"type":"link","label":"Draft Document","href":"/docs/API-docs/v1/draftdocument","className":"api-method post","docId":"API-docs/v1/draftdocument","unlisted":false},{"type":"link","label":"Create Document","href":"/docs/API-docs/v1/createdocument","className":"api-method post","docId":"API-docs/v1/createdocument","unlisted":false},{"type":"link","label":"Create Document from Template","href":"/docs/API-docs/v1/createdocumentwithtemplateid","className":"api-method post","docId":"API-docs/v1/createdocumentwithtemplateid","unlisted":false},{"type":"link","label":"Get Document","href":"/docs/API-docs/v1/getdocument","className":"api-method get","docId":"API-docs/v1/getdocument","unlisted":false},{"type":"link","label":"Update Document","href":"/docs/API-docs/v1/update-document","className":"api-method put","docId":"API-docs/v1/update-document","unlisted":false},{"type":"link","label":"Revoke Document","href":"/docs/API-docs/v1/revokedocument","className":"api-method post","docId":"API-docs/v1/revokedocument","unlisted":false},{"type":"link","label":"Delete Document","href":"/docs/API-docs/v1/deletedocument","className":"api-method delete","docId":"API-docs/v1/deletedocument","unlisted":false},{"type":"link","label":"Get Document list from status","href":"/docs/API-docs/v1/getdocumentlist","className":"api-method get","docId":"API-docs/v1/getdocumentlist","unlisted":false},{"type":"link","label":"Resend request mail","href":"/docs/API-docs/v1/resendrequestmail","className":"api-method post","docId":"API-docs/v1/resendrequestmail","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","label":"Draft Template","href":"/docs/API-docs/v1/drafttemplate","className":"api-method post","docId":"API-docs/v1/drafttemplate","unlisted":false},{"type":"link","label":"Create Template","href":"/docs/API-docs/v1/createtemplate","className":"api-method post","docId":"API-docs/v1/createtemplate","unlisted":false},{"type":"link","label":"Get Template","href":"/docs/API-docs/v1/get-template","className":"api-method get","docId":"API-docs/v1/get-template","unlisted":false},{"type":"link","label":"Update Template","href":"/docs/API-docs/v1/update-template","className":"api-method put","docId":"API-docs/v1/update-template","unlisted":false},{"type":"link","label":"Delete Template","href":"/docs/API-docs/v1/delete-template","className":"api-method delete","docId":"API-docs/v1/delete-template","unlisted":false},{"type":"link","label":"Get Template list","href":"/docs/API-docs/v1/gettemplatelist","className":"api-method get","docId":"API-docs/v1/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","label":"Get Webhook","href":"/docs/API-docs/v1/get-webhook","className":"api-method get","docId":"API-docs/v1/get-webhook","unlisted":false},{"type":"link","label":"Save or Update Webhook","href":"/docs/API-docs/v1/save-update-webhook","className":"api-method post","docId":"API-docs/v1/save-update-webhook","unlisted":false},{"type":"link","label":"Delete Webhook","href":"/docs/API-docs/v1/delete-webhook","className":"api-method delete","docId":"API-docs/v1/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Folder","items":[{"type":"link","label":"Create Folder","href":"/docs/API-docs/v1/createfolder","className":"api-method post","docId":"API-docs/v1/createfolder","unlisted":false},{"type":"link","label":"Get Folder","href":"/docs/API-docs/v1/getfolder","className":"api-method get","docId":"API-docs/v1/getfolder","unlisted":false},{"type":"link","label":"Update Folder","href":"/docs/API-docs/v1/updatefolder","className":"api-method put","docId":"API-docs/v1/updatefolder","unlisted":false},{"type":"link","label":"Delete Folder","href":"/docs/API-docs/v1/deletefolder","className":"api-method delete","docId":"API-docs/v1/deletefolder","unlisted":false},{"type":"link","label":"Get folder list","href":"/docs/API-docs/v1/folderlist","className":"api-method get","docId":"API-docs/v1/folderlist","unlisted":false}],"collapsed":true,"collapsible":true}],"collapsible":true,"href":"/docs/API-docs/v1"}]},"docs":{"API-docs/api-intro":{"id":"API-docs/api-intro","title":"OpenSign APIs","description":"Welcome to the OpenSign API. Choose a version from the sidebar:"},"API-docs/v1.1/contactlist":{"id":"API-docs/v1.1/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar":"apiSidebar"},"API-docs/v1.1/createcontact":{"id":"API-docs/v1.1/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar":"apiSidebar"},"API-docs/v1.1/createdocument":{"id":"API-docs/v1.1/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1.1/createdocumentwithtemplateid":{"id":"API-docs/v1.1/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar":"apiSidebar"},"API-docs/v1.1/createfolder":{"id":"API-docs/v1.1/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","sidebar":"apiSidebar"},"API-docs/v1.1/createtemplate":{"id":"API-docs/v1.1/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar":"apiSidebar"},"API-docs/v1.1/delete-template":{"id":"API-docs/v1.1/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar":"apiSidebar"},"API-docs/v1.1/delete-webhook":{"id":"API-docs/v1.1/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar":"apiSidebar"},"API-docs/v1.1/deletecontact":{"id":"API-docs/v1.1/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar":"apiSidebar"},"API-docs/v1.1/deletedocument":{"id":"API-docs/v1.1/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1.1/deletefolder":{"id":"API-docs/v1.1/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","sidebar":"apiSidebar"},"API-docs/v1.1/draftdocument":{"id":"API-docs/v1.1/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1.1/drafttemplate":{"id":"API-docs/v1.1/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar":"apiSidebar"},"API-docs/v1.1/folderlist":{"id":"API-docs/v1.1/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","sidebar":"apiSidebar"},"API-docs/v1.1/get-template":{"id":"API-docs/v1.1/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar":"apiSidebar"},"API-docs/v1.1/get-user":{"id":"API-docs/v1.1/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar":"apiSidebar"},"API-docs/v1.1/get-webhook":{"id":"API-docs/v1.1/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar":"apiSidebar"},"API-docs/v1.1/getcontact":{"id":"API-docs/v1.1/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar":"apiSidebar"},"API-docs/v1.1/getcredits":{"id":"API-docs/v1.1/getcredits","title":"Get your API credits","description":"The Get Credits API returns details about the credits available to your account:","sidebar":"apiSidebar"},"API-docs/v1.1/getdocument":{"id":"API-docs/v1.1/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar":"apiSidebar"},"API-docs/v1.1/getdocumentlist":{"id":"API-docs/v1.1/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/v1.1/getfolder":{"id":"API-docs/v1.1/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","sidebar":"apiSidebar"},"API-docs/v1.1/gettemplatelist":{"id":"API-docs/v1.1/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar":"apiSidebar"},"API-docs/v1.1/intro":{"id":"API-docs/v1.1/intro","title":"Overview","description":"OpenSign\u2122 API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures."},"API-docs/v1.1/opensign-api-v-1-1":{"id":"API-docs/v1.1/opensign-api-v-1-1","title":"OpenSign API v1.1","description":"Welcome to the **OpenSign\u2122 API v1.1** documentation.","sidebar":"apiSidebar"},"API-docs/v1.1/publictemplate":{"id":"API-docs/v1.1/publictemplate","title":"Public Template","description":"The Public Template API allows users to create templates that serve as blueprints for generating documents with predefined structures. When a template is successfully created, the API returns a unique **template_id** and a **public_url**. The **public_url** is publicly accessible and may be shared with any user, enabling them to generate and sign documents based on the template. However, the template itself cannot be modified through this URL; it can only be used for document creation and signing.","sidebar":"apiSidebar"},"API-docs/v1.1/resendrequestmail":{"id":"API-docs/v1.1/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","sidebar":"apiSidebar"},"API-docs/v1.1/revokedocument":{"id":"API-docs/v1.1/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1.1/save-update-webhook":{"id":"API-docs/v1.1/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar":"apiSidebar"},"API-docs/v1.1/selfsign":{"id":"API-docs/v1.1/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar":"apiSidebar"},"API-docs/v1.1/update-document":{"id":"API-docs/v1.1/update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","sidebar":"apiSidebar"},"API-docs/v1.1/update-template":{"id":"API-docs/v1.1/update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","sidebar":"apiSidebar"},"API-docs/v1.1/updatefolder":{"id":"API-docs/v1.1/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","sidebar":"apiSidebar"},"API-docs/v1/contactlist":{"id":"API-docs/v1/contactlist","title":"Get Contact list","description":"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.","sidebar":"apiSidebar"},"API-docs/v1/createcontact":{"id":"API-docs/v1/createcontact","title":"Create Contact","description":"The Create Contact API allows you to effortlessly create new contacts that can act as signers for your important documents.","sidebar":"apiSidebar"},"API-docs/v1/createdocument":{"id":"API-docs/v1/createdocument","title":"Create Document","description":"The Create Document API allows users to generate new documents by providing data with base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1/createdocumentwithtemplateid":{"id":"API-docs/v1/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document from template API allows you to generate new documents by just providing template_id instead of uploading a new file(in the form of base64 or binary) every time you need to create a document. Templates for repeatedly used files can be created from user interface at [**Debug UI**](https://app.opensignlabs.com/debugpdf) or using the Create Template API.","sidebar":"apiSidebar"},"API-docs/v1/createfolder":{"id":"API-docs/v1/createfolder","title":"Create Folder","description":"The Create Folder API allows you to create folder.","sidebar":"apiSidebar"},"API-docs/v1/createtemplate":{"id":"API-docs/v1/createtemplate","title":"Create Template","description":"The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template.","sidebar":"apiSidebar"},"API-docs/v1/delete-template":{"id":"API-docs/v1/delete-template","title":"Delete Template","description":"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed","sidebar":"apiSidebar"},"API-docs/v1/delete-webhook":{"id":"API-docs/v1/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar":"apiSidebar"},"API-docs/v1/deletecontact":{"id":"API-docs/v1/deletecontact","title":"Delete Contact","description":"The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact\'s information, this API makes it easy to delete their record.","sidebar":"apiSidebar"},"API-docs/v1/deletedocument":{"id":"API-docs/v1/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1/deletefolder":{"id":"API-docs/v1/deletefolder","title":"Delete Folder","description":"The delete Folder API allows you to delete folder.","sidebar":"apiSidebar"},"API-docs/v1/draftdocument":{"id":"API-docs/v1/draftdocument","title":"Draft Document","description":"The Draft Document API allows users to generate new documents by providing data with a base64 encoded file.","sidebar":"apiSidebar"},"API-docs/v1/drafttemplate":{"id":"API-docs/v1/drafttemplate","title":"Draft Template","description":"The Template Drafting API enables users to create customizable templates, serving as blueprints for generating documents with predefined structures. Upon successful creation of a template, the API returns a unique **objectId** (designated as template_id), which can be used to generate documents based on the specified template. Additionally, a **url** is provided, which offers a user interface for editing the template and facilitating document distribution.","sidebar":"apiSidebar"},"API-docs/v1/folderlist":{"id":"API-docs/v1/folderlist","title":"Get folder list","description":"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId","sidebar":"apiSidebar"},"API-docs/v1/get-template":{"id":"API-docs/v1/get-template","title":"Get Template","description":"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.","sidebar":"apiSidebar"},"API-docs/v1/get-user":{"id":"API-docs/v1/get-user","title":"Get your account details","description":"The Get User API enables you to get your own account details.","sidebar":"apiSidebar"},"API-docs/v1/get-webhook":{"id":"API-docs/v1/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar":"apiSidebar"},"API-docs/v1/getcontact":{"id":"API-docs/v1/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar":"apiSidebar"},"API-docs/v1/getdocument":{"id":"API-docs/v1/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar":"apiSidebar"},"API-docs/v1/getdocumentlist":{"id":"API-docs/v1/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/v1/getfolder":{"id":"API-docs/v1/getfolder","title":"Get Folder","description":"The Get Folder API allows you to retrieve details about a specific folder.","sidebar":"apiSidebar"},"API-docs/v1/gettemplatelist":{"id":"API-docs/v1/gettemplatelist","title":"Get Template list","description":"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.","sidebar":"apiSidebar"},"API-docs/v1/intro":{"id":"API-docs/v1/intro","title":"Overview","description":"OpenSign\u2122 API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures."},"API-docs/v1/opensign-api-v-1":{"id":"API-docs/v1/opensign-api-v-1","title":"OpenSign API v1","description":"Welcome to the OpenSign\u2122 API documentation!","sidebar":"apiSidebar"},"API-docs/v1/resendrequestmail":{"id":"API-docs/v1/resendrequestmail","title":"Resend request mail","description":"Resend request mail to user for signing document.","sidebar":"apiSidebar"},"API-docs/v1/revokedocument":{"id":"API-docs/v1/revokedocument","title":"Revoke Document","description":"The Revoke document API allows you to revoke specific document from your documents.","sidebar":"apiSidebar"},"API-docs/v1/save-update-webhook":{"id":"API-docs/v1/save-update-webhook","title":"Save or Update Webhook","description":"The save or update Webhook API allows you to save a webhook URL which is used to trigger events.","sidebar":"apiSidebar"},"API-docs/v1/selfsign":{"id":"API-docs/v1/selfsign","title":"Self Sign","description":"The selfsign API generates a URL that enables freestyle signing of a document. You can also include optional pre-defined widgets, which the signer can edit or expand upon as needed. This provides a signing experience similar to the \u201cSign Yourself\u201d flow in the OpenSign app.","sidebar":"apiSidebar"},"API-docs/v1/update-document":{"id":"API-docs/v1/update-document","title":"Update Document","description":"The Update Document API allows users to modify and update the details of a specific document. Note that this API only allows to update a few parameters, you cannot change the file once it the document is created.","sidebar":"apiSidebar"},"API-docs/v1/update-template":{"id":"API-docs/v1/update-template","title":"Update Template","description":"The Update Template API enables you to modify and update the details of a specific template.","sidebar":"apiSidebar"},"API-docs/v1/updatefolder":{"id":"API-docs/v1/updatefolder","title":"Update Folder","description":"The Update Folder API allows you to uodate folder name as well as parentFolderId.","sidebar":"apiSidebar"},"contribute/CODE_OF_CONDUCT":{"id":"contribute/CODE_OF_CONDUCT","title":"Code of conduct","description":"1. Introduction","sidebar":"contributeSidebar"},"contribute/COMMUNITY":{"id":"contribute/COMMUNITY","title":"Community at OpenSign\u2122","description":"Welcome to the OpenSign\u2122 Community page! OpenSign\u2122 is dedicated to fostering a vibrant and engaging community where members can connect, share ideas and collaborate on the OpenSign\u2122 project. This page provides links to our active social media platforms and community channels, offering various ways for you to join and participate in the OpenSign\u2122 community. Whether you\'re looking for support, eager to contribute or just want to stay updated, you\'ll find a platform that suits your preference. Connect with us on Discord for real-time discussions, follow us on Twitter for the latest updates, engage with our professional network on LinkedIn or join our Facebook group for a broader community experience. Join us in our mission to develop OpenSign\u2122 as the premier open-source alternative to DocuSign.","sidebar":"contributeSidebar"},"contribute/INSTALLATION":{"id":"contribute/INSTALLATION","title":"Installation instructions","description":"You can use our app as a cloud version from OpenSignLabs","sidebar":"contributeSidebar"},"contribute/intro":{"id":"contribute/intro","title":"Contributing to OpenSign","description":"Hello there! Thank you for considering contributing to OpenSign, the open-source alternative to DocuSign. OpenSign is not just a project, but a community endeavor that aims to create a robust, user-friendly, and secure electronic signature solution. Your contributions, irrespective of their size, are valuable in making this vision a reality.","sidebar":"contributeSidebar"},"contribute/REPORTING_GUIDELINES":{"id":"contribute/REPORTING_GUIDELINES","title":"OpenSign\u2122 Reporting Guidelines","description":"This document provides guidelines for reporting issues, suggesting enhancements, and submitting pull requests to the OpenSign\u2122 GitHub repository. Adhering to these guidelines helps maintain the project\'s quality and efficiency.","sidebar":"contributeSidebar"},"help/FAQs/Ensure this field is accurately filled and meets all requirements":{"id":"help/FAQs/Ensure this field is accurately filled and meets all requirements","title":"Why am I getting \'Ensure this field is accurately filled and meets all requirements\'?","description":"This happens when you leave a field blank or when you don\u2019t enter correct values in the field, for example not entering email address in correct format.","sidebar":"tutorialSidebar"},"help/FAQs/FAQs":{"id":"help/FAQs/FAQs","title":"Why is there no dropdown list when I sign a document myself?","description":"The dropdown list field is available only when you request a signature from others or when you create a template. This is because dropdown lists function as temporary widgets, allowing the user to select one of multiple values. Once a signer selects a value from the dropdown, it is embedded into the document as text. When you sign a document yourself, OpenSign digitally signs it immediately upon clicking the finish button. Therefore, you can use the text widget to add the necessary text to the document.","sidebar":"tutorialSidebar"},"help/FAQs/Max File Upload Size":{"id":"help/FAQs/Max File Upload Size","title":"Max File Upload Size","description":"\u2753 What is the default maximum file size that can be uploaded to OpenSign?","sidebar":"tutorialSidebar"},"help/FAQs/User Deletion":{"id":"help/FAQs/User Deletion","title":"User Deletion","description":"\u2753 Who can delete users?","sidebar":"tutorialSidebar"},"help/intro":{"id":"help/intro","title":"Intro","description":"\ud83c\udf1fGet ready for an electrifying journey at OpenSign\u2122, the most incredibly documented open source document signing solution! \ud83d\ude80 This is your go-to spot for diving deep into everything OpenSign\u2122 has to offer. Whether you\u2019re just starting out or you\u2019re a seasoned pro eager to uncover even more cool features, we\u2019ve got you covered with the most awesome, top-notch guides and resources around. Get ready to make the most out of OpenSign\u2122 \ud83c\udf89\ud83d\udcda\ud83d\udd0d Your adventure in excellence starts here! \ud83c\udf08\u2728\ud83c\udf1f","sidebar":"tutorialSidebar"},"help/New-Document/edit-document-before-sending":{"id":"help/New-Document/edit-document-before-sending","title":"Editing Your Document Before Sending","description":"OpenSign\u2122 lets you polish your PDF before you send it out\u2014whether you\u2019re signing it yourself, requesting signatures, or saving it as a template. You get four core editing controls right in the preview:","sidebar":"tutorialSidebar"},"help/New-Document/enforce-email-verification":{"id":"help/New-Document/enforce-email-verification","title":"Enforce email OTP verification","description":"The \\"Enable OTP Verification\\" feature in OpenSign is designed to add an extra layer of security to the document-signing process by verifying the signer\u2019s email address. Here\u2019s an in-depth look at how it works, when to use it, and its impact on the signing process.","sidebar":"tutorialSidebar"},"help/New-Document/request-signatures":{"id":"help/New-Document/request-signatures","title":"Request signatures","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/New-Document/sign-yourself":{"id":"help/New-Document/sign-yourself","title":"Sign your-self","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/New-Document/widgets":{"id":"help/New-Document/widgets","title":"Widgets in OpenSign","description":"Widgets in OpenSign are interactive fields that you can place on your documents to collect information, signatures, or confirmations from recipients during the signing process.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/create-document":{"id":"help/OpenSign\u2122 Drive/create-document","title":"Create Docs & Folders","description":"OpenSign Drive offers a streamlined way to manage, sign, and request signatures on your important documents. Whether you\'re drafting an offer letter or storing signed agreements, organizing your documents effectively is crucial. Here\u2019s a step-by-step guide on how to create documents and folders in OpenSign Drive.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/list-grid-view":{"id":"help/OpenSign\u2122 Drive/list-grid-view","title":"Grid vs List view","description":"- Navigate to OpenSign drive using the main menu or clicking this link.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/organize-documents":{"id":"help/OpenSign\u2122 Drive/organize-documents","title":"OpenSign\u2122 Drive Interface Documentation","description":"Overview","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/rename-document":{"id":"help/OpenSign\u2122 Drive/rename-document","title":"Rename documents from OpenSign\u2122 Drive","description":"The OpenSign\u2122 Drive interface allows users to rename their documents efficiently.","sidebar":"tutorialSidebar"},"help/Reports/completed":{"id":"help/Reports/completed","title":"Completed","description":"---","sidebar":"tutorialSidebar"},"help/Reports/contactbook":{"id":"help/Reports/contactbook","title":"Contactbook","description":"The Contactbook report in OpenSign enables you to add and manage contacts.","sidebar":"tutorialSidebar"},"help/Reports/declined":{"id":"help/Reports/declined","title":"Declined","description":"The \\"Declined documents\\" report within OpenSign serves as a vital tool for managing and reviewing all declined documents that have been processed through the platform. This guide will walk you through the key features and functionalities of the \\"Declined documents\\" report, enabling you to efficiently navigate and manage your signed documents.","sidebar":"tutorialSidebar"},"help/Reports/drafts":{"id":"help/Reports/drafts","title":"Drafts","description":"The Draft documents section in OpenSign helps you manage all your in-progress documents easily. This feature allows you to save, review, and edit documents before sending them for signature. Here\'s a detailed overview of how to navigate and use the Draft Documents report effectively.","sidebar":"tutorialSidebar"},"help/Reports/expired":{"id":"help/Reports/expired","title":"Expired","description":"The Expired documents report in OpenSign allows you to manage and review documents that have reached their expiration date without being signed. This feature is essential for maintaining an organized record of inactive documents that may require follow-up or archival.","sidebar":"tutorialSidebar"},"help/Reports/in-progress":{"id":"help/Reports/in-progress","title":"In Progress","description":"The In-Progress documents report in OpenSign helps you monitor and manage documents that are currently in the signing process. This report enables you to monitor the status of your documents, manually share the document URL, track document progress, resend reminders, revoke access, or delete documents that are no longer required. Here\u2019s a detailed guide on how to use the In-Progress documents report effectively.","sidebar":"tutorialSidebar"},"help/Reports/need-your-sign":{"id":"help/Reports/need-your-sign","title":"Need your sign","description":"The \\"Need your sign\\" feature in OpenSign is designed to simplify the process of managing documents that require your signature. This guide will walk you through the various elements of the \\"Need your sign\\" report, helping you to efficiently navigate and complete your pending signing tasks.","sidebar":"tutorialSidebar"},"help/Settings/APIToken":{"id":"help/Settings/APIToken","title":"API Token","description":"To authenticate and use OpenSign API endpoints, you\u2019ll need a valid API token (x-api-token).","sidebar":"tutorialSidebar"},"help/Settings/Custom-email-templates":{"id":"help/Settings/Custom-email-templates","title":"Custom email templates","description":"\ud83d\ude80 Steps to Set Up Custom Email Templates","sidebar":"tutorialSidebar"},"help/Settings/disabledocumentid":{"id":"help/Settings/disabledocumentid","title":"Disable DocumentId","description":"Whenever a document is signed by all parties, OpenSign\u2122 adds a DocumentId at the top left corner of the digitally signed document.","sidebar":"tutorialSidebar"},"help/Settings/manage-users":{"id":"help/Settings/manage-users","title":"Manage users","description":"The User Management feature in OpenSign allows administrators to add, edit, and manage users within the platform. This functionality is available on Self-Hosted, Teams, and Enterprise plans.","sidebar":"tutorialSidebar"},"help/Settings/my-signature":{"id":"help/Settings/my-signature","title":"My Signature","description":"This guide provides instructions on how to save your signature and initials using the OpenSign application. Once saved, you can use them with one click when signing documents. To create your signature, start by clicking the \\"My Signature\\" link under \\"settings\\" menu.","sidebar":"tutorialSidebar"},"help/Settings/Preferences":{"id":"help/Settings/Preferences","title":"Preferences","description":"The Preferences page in OpenSign\u2122 allows users and administrators to tailor the signing experience to suit individual, team, or organizational needs. Below is a breakdown of all configurable options and what they control.","sidebar":"tutorialSidebar"},"help/Settings/SecurityManagement":{"id":"help/Settings/SecurityManagement","title":"Security","description":"\u2705 Two-Factor Authentication (2FA)","sidebar":"tutorialSidebar"},"help/Settings/Teams":{"id":"help/Settings/Teams","title":"Manage Teams","description":"The Teams feature in OpenSign allows you to organize your users into structured groups for easier management, permissions control, and streamlined workflow configuration.","sidebar":"tutorialSidebar"},"help/Settings/Webhook":{"id":"help/Settings/Webhook","title":"Webhook","description":"\ud83d\udd14 What is a Webhook?","sidebar":"tutorialSidebar"},"help/Templates/create-template":{"id":"help/Templates/create-template","title":"Create Templates","description":"Getting Started","sidebar":"tutorialSidebar"},"help/Templates/embed-template":{"id":"help/Templates/embed-template","title":"Embedding OpenSign templates","description":"OpenSign Template Embedding allows users to seamlessly integrate public document templates into their websites or applications. By embedding templates, you can provide a direct and interactive signing experience for your users without requiring them to leave your platform. This feature supports various technologies like React, Next.js, HTML, JavaScript, and Angular, making it easy to add signing capabilities to different web projects.","sidebar":"tutorialSidebar"},"help/Templates/manage-templates":{"id":"help/Templates/manage-templates","title":"Manage Templates","description":"Viewing and Managing Templates","sidebar":"tutorialSidebar"},"help/Templates/publicTemplate":{"id":"help/Templates/publicTemplate","title":"Setting up an OpenSign template for public signing","description":"The OpenSign Public profile feature offers the ultimate public document signing solution without any need for integrations. With this feature, users can share document templates publicly, allowing anyone to access and sign the documents directly through the shared templates. This streamlines the signing process by providing a seamless, accessible way for public signers to complete documents without additional steps or integrations.","sidebar":"tutorialSidebar"},"help/Templates/quick-send":{"id":"help/Templates/quick-send","title":"Quickly Send the Document for Signature Using Template","description":"Step 1: Begin New Template Creation","sidebar":"tutorialSidebar"},"help/Templates/use-template":{"id":"help/Templates/use-template","title":"Use template to create documents","description":"Step 1: Begin New Template Creation","sidebar":"tutorialSidebar"},"help/User Menu/Console/analystics":{"id":"help/User Menu/Console/analystics","title":"Analytics","description":"Documents Signed","sidebar":"tutorialSidebar"},"help/User Menu/Console/branding":{"id":"help/User Menu/Console/branding","title":"Branding","description":"Custom Subdomain","sidebar":"tutorialSidebar"},"help/User Menu/Console/custom_filestorage":{"id":"help/User Menu/Console/custom_filestorage","title":"Custom File Storage","description":"\ud83c\udf29\ufe0f Introduction to BYOC (Bring Your Own Cloud)","sidebar":"tutorialSidebar"},"help/User Menu/Console/emails":{"id":"help/User Menu/Console/emails","title":"Email Templates","description":"This page allows the admin user to configure and manage customized email templates at the organization level.","sidebar":"tutorialSidebar"},"help/User Menu/Console/general":{"id":"help/User Menu/Console/general","title":"General","description":"The General Settings section in OpenSign provides key administrative settings to help you manage and control the overall configuration of your OpenSign platform.","sidebar":"tutorialSidebar"},"help/User Menu/Console/globalSMTP":{"id":"help/User Menu/Console/globalSMTP","title":"Preferences","description":"\ud83c\udfe2 SMTP at the Organization Level","sidebar":"tutorialSidebar"},"help/User Menu/Console/orgadmin":{"id":"help/User Menu/Console/orgadmin","title":"Org Admins","description":"The Org Admins section allows administrators to manage organization-level admin users within OpenSign.","sidebar":"tutorialSidebar"},"help/User Menu/Console/organizations":{"id":"help/User Menu/Console/organizations","title":"Organizations","description":"The Organizations section in OpenSign allows administrators to create and manage separate groups within a Team or Enterprise account.","sidebar":"tutorialSidebar"},"help/User Menu/Console/signing_certificate":{"id":"help/User Menu/Console/signing_certificate","title":"Custom Signing Certificate","description":"The Custom Signing Certificate page allows you to upload and manage your own digital signing certificate (PFX format) for secure and verified document signing in OpenSign.","sidebar":"tutorialSidebar"},"help/User Menu/Profile":{"id":"help/User Menu/Profile","title":"Profile","description":"The Profile in OpenSign allows users to manage their personal and account-related details. You can update your information, verify your email, and set up a public profile.","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Tutorial Intro","description":"Let\'s discover Docusaurus in less than 5 minutes."},"self-host/cloud-storage/s3":{"id":"self-host/cloud-storage/s3","title":"AWS S3","description":"You can create an AWS S3 bucket to store your uploaded documents using OpenSign\u2122","sidebar":"selfhostSidebar"},"self-host/docker/run-locally":{"id":"self-host/docker/run-locally","title":"Self-host OpenSign\u2122 with Docker on Linux/MacOS/Windows","description":"Steps to run OpenSign\u2122 with docker on Linux/MacOS/Windows:","sidebar":"selfhostSidebar"},"self-host/docker/upgrade-deployment":{"id":"self-host/docker/upgrade-deployment","title":"OpenSign\u2122 Self-Hosted \'Upgrade Deployment\' Guide Using Docker on Linux, macOS, or Windows","description":"This guide provides step-by-step instructions to upgrade the deployment of OpenSign using Docker.","sidebar":"selfhostSidebar"},"self-host/guides/azure-vm-setup":{"id":"self-host/guides/azure-vm-setup","title":"OpenSign Deployment Guide on Azure VM via command-line","description":"\ud83e\uddf1 Prerequisites","sidebar":"selfhostSidebar"},"self-host/guides/env-variables":{"id":"self-host/guides/env-variables","title":"ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","description":"Information About ENV variables which are used to setup OpenSign\u2122 with Docker on Localhost","sidebar":"selfhostSidebar"},"self-host/guides/how-to-generate-self-signed-document-signing-certificate":{"id":"self-host/guides/how-to-generate-self-signed-document-signing-certificate","title":"How to generate self-signed document signing certificate?","description":"","sidebar":"selfhostSidebar"},"self-host/guides/upgrade-to-v2.1.0":{"id":"self-host/guides/upgrade-to-v2.1.0","title":"How to upgrade self-hosted OpenSign to v2.1.0?","description":"For self-hosted deployments, version 2.1.0 introduces changes to the signup process:","sidebar":"selfhostSidebar"},"self-host/intro":{"id":"self-host/intro","title":"Self-Hosting OpenSign","description":"This section of the OpenSign\u2122 documentation is dedicated to guiding you through the process of self-hosting the OpenSign platform. Self-hosting OpenSign allows for greater control and customization, ensuring that it aligns perfectly with your specific needs and infrastructure requirements. We cover everything from initial setup, configuration options, to maintenance best practices. Whether you are an individual enthusiast or a professional looking to deploy OpenSign in a corporate environment, this guide will provide you with the necessary steps and tips to successfully self-host OpenSign\u2122 - the best open source document signing infrastructure.","sidebar":"selfhostSidebar"},"self-host/One-click-Install/DigitalOcean":{"id":"self-host/One-click-Install/DigitalOcean","title":"Digital Ocean","description":"OpenSign application consists of 3 components -","sidebar":"selfhostSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/20f41f87.b83e36a4.js b/assets/js/20f41f87.b83e36a4.js new file mode 100644 index 000000000..7cb9a578e --- /dev/null +++ b/assets/js/20f41f87.b83e36a4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7381],{28453:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>r});var t=s(96540);const i={},l=t.createContext(i);function o(e){const n=t.useContext(l);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(l.Provider,{value:n},e.children)}},43921:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>t,toc:()=>c});const t=JSON.parse('{"id":"help/User Menu/Console/globalSMTP","title":"Preferences","description":"\ud83c\udfe2 SMTP at the Organization Level","source":"@site/docs/help/User Menu/Console/globalSMTP.md","sourceDirName":"help/User Menu/Console","slug":"/help/User Menu/Console/globalSMTP","permalink":"/docs/help/User Menu/Console/globalSMTP","draft":false,"unlisted":false,"editUrl":"https://github.com/opensignlabs/opensign/tree/feat-docs/docs/docs/help/User Menu/Console/globalSMTP.md","tags":[],"version":"current","sidebarPosition":4,"frontMatter":{"sidebar_position":4,"title":"Preferences"},"sidebar":"tutorialSidebar","previous":{"title":"Branding","permalink":"/docs/help/User Menu/Console/branding"},"next":{"title":"Custom File Storage","permalink":"/docs/help/User Menu/Console/custom_filestorage"}}');var i=s(74848),l=s(28453);const o={sidebar_position:4,title:"Preferences"},r=void 0,a={},c=[{value:"\ud83c\udfe2 SMTP at the Organization Level",id:"-smtp-at-the-organization-level",level:2},{value:"How to Set Up SMTP at the Organization Level",id:"how-to-set-up-smtp-at-the-organization-level",level:3},{value:"\ud83d\udd17 Connect to Gmail",id:"-connect-to-gmail",level:3},{value:"\u2699\ufe0f Custom SMTP",id:"\ufe0f-custom-smtp",level:3},{value:"\ud83d\udce4 OpenSign\u2122 Default SMTP",id:"-opensign-default-smtp",level:3}];function d(e){const n={blockquote:"blockquote",br:"br",code:"code",h2:"h2",h3:"h3",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,l.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"-smtp-at-the-organization-level",children:"\ud83c\udfe2 SMTP at the Organization Level"}),"\n",(0,i.jsxs)(n.p,{children:["Configure SMTP at the organization level to send all outgoing emails\u2014such as request-signature and completion emails\u2014using a company-configured SMTP server.",(0,i.jsx)(n.br,{}),"\n","When enabled, these settings apply to all users ",(0,i.jsx)(n.strong,{children:"unless individual SMTP customization is allowed and set up by the user"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"how-to-set-up-smtp-at-the-organization-level",children:"How to Set Up SMTP at the Organization Level"}),"\n",(0,i.jsx)(n.p,{children:"Admins can manage and enforce SMTP settings across the entire platform."}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Step 1:"})," Open the profile menu and select ",(0,i.jsx)(n.strong,{children:"Console Application"})," to access the admin console.",(0,i.jsx)(n.br,{}),"\n",(0,i.jsx)(n.strong,{children:"Step 2:"})," In the Console, navigate to the ",(0,i.jsx)(n.strong,{children:"Global SMTP"})," section and configure your SMTP settings."]}),"\n",(0,i.jsxs)(n.p,{children:["All users under your organization will automatically use the organization-level SMTP ",(0,i.jsx)(n.strong,{children:"unless"})," they are allowed to configure their own SMTP settings."]}),"\n",(0,i.jsx)("img",{width:"861",height:"409",alt:"Global SMTP",src:"https://github.com/user-attachments/assets/fe9dc091-59dd-47f9-992a-811cecaac2f3"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Example:"}),(0,i.jsx)(n.br,{}),"\n","Adam, the administrator, disables ",(0,i.jsx)(n.strong,{children:"Enable individual user SMTP settings"})," under ",(0,i.jsx)(n.strong,{children:"Console \u2192 General"}),".",(0,i.jsx)(n.br,{}),"\n","As a result, Ursula cannot configure her own SMTP."]}),"\n",(0,i.jsxs)(n.p,{children:["When Ursula sends a document to Sofia for signing, Sofia receives emails sent through the ",(0,i.jsx)(n.strong,{children:"organization-level SMTP"}),".",(0,i.jsx)(n.br,{}),"\n","If Adam enables ",(0,i.jsx)(n.strong,{children:"Enable individual user SMTP settings"}),", but Ursula does not configure her own SMTP, emails will still be sent using the ",(0,i.jsx)(n.strong,{children:"organization-level SMTP"}),"."]}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Note:"})," Organization-level SMTP configuration is available ",(0,i.jsx)(n.strong,{children:"only on Paid plans"})," and is not included in ",(0,i.jsx)(n.strong,{children:"Free"})," plans."]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"-connect-to-gmail",children:"\ud83d\udd17 Connect to Gmail"}),"\n",(0,i.jsxs)(n.p,{children:["Send request-signature emails directly from your ",(0,i.jsx)(n.strong,{children:"Gmail account"}),"."]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["Click ",(0,i.jsx)(n.strong,{children:"Connect to Gmail"})]}),"\n",(0,i.jsx)(n.li,{children:"A popup will appear prompting you to sign in"}),"\n",(0,i.jsx)(n.li,{children:"Grant the required access permissions"}),"\n",(0,i.jsx)(n.li,{children:"Once authorized, OpenSign will send emails using your Gmail account"}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"\ufe0f-custom-smtp",children:"\u2699\ufe0f Custom SMTP"}),"\n",(0,i.jsx)(n.p,{children:"Configure any third-party SMTP provider such as SMTP2GO or Mailgun."}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["Click ",(0,i.jsx)(n.strong,{children:"Custom SMTP"})]}),"\n",(0,i.jsxs)(n.li,{children:["A popup will appear asking for your SMTP details:","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Host:"})," SMTP server host (e.g., ",(0,i.jsx)(n.code,{children:"mail.smtp2go.com"}),")"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Port:"})," SMTP port (e.g., ",(0,i.jsx)(n.code,{children:"2525"}),")"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Sender Email:"})," Email address configured in your SMTP account"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Username:"})," SMTP username"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Password:"})," SMTP password"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)("img",{width:"820",alt:"Custom smtp",src:"https://github.com/user-attachments/assets/a3c33510-11b9-4a32-bd44-99614182b089"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h3,{id:"-opensign-default-smtp",children:"\ud83d\udce4 OpenSign\u2122 Default SMTP"}),"\n",(0,i.jsx)(n.p,{children:"If selected, all request-signature and completion emails will be sent using OpenSign\u2019s built-in SMTP server."})]})}function h(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}}}]); \ No newline at end of file diff --git a/assets/js/4acb0154.9d3b7447.js b/assets/js/4acb0154.9d3b7447.js deleted file mode 100644 index 5c18d149b..000000000 --- a/assets/js/4acb0154.9d3b7447.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[791],{5859:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>l,default:()=>h,frontMatter:()=>o,metadata:()=>t,toc:()=>c});const t=JSON.parse('{"id":"help/User Menu/Console/general","title":"General","description":"The General Settings section in OpenSign provides key administrative settings to help you manage and control the overall configuration of your OpenSign platform.","source":"@site/docs/help/User Menu/Console/general.md","sourceDirName":"help/User Menu/Console","slug":"/help/User Menu/Console/general","permalink":"/docs/help/User Menu/Console/general","draft":false,"unlisted":false,"editUrl":"https://github.com/opensignlabs/opensign/tree/feat-docs/docs/docs/help/User Menu/Console/general.md","tags":[],"version":"current","sidebarPosition":2,"frontMatter":{"sidebar_position":2,"title":"General"},"sidebar":"tutorialSidebar","previous":{"title":"Analytics","permalink":"/docs/help/User Menu/Console/analystics"},"next":{"title":"Branding","permalink":"/docs/help/User Menu/Console/branding"}}');var i=s(74848),r=s(28453);const o={sidebar_position:2,title:"General"},l="General Settings",a={},c=[{value:"\ud83d\ude80 How to Access the General Settings Page",id:"-how-to-access-the-general-settings-page",level:2},{value:"Enabled Signature Types",id:"enabled-signature-types",level:2},{value:"Allow Indexing of Public Profile",id:"allow-indexing-of-public-profile",level:2},{value:"Email Template Customization",id:"email-template-customization",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",br:"br",h1:"h1",h2:"h2",header:"header",hr:"hr",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"general-settings",children:"General Settings"})}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.strong,{children:"General Settings"})," section in OpenSign provides key administrative settings to help you manage and control the overall configuration of your OpenSign platform."]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"-how-to-access-the-general-settings-page",children:"\ud83d\ude80 How to Access the General Settings Page"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["Log in to your ",(0,i.jsx)(n.strong,{children:"OpenSign"})," account using an ",(0,i.jsx)(n.strong,{children:"Admin account"}),"."]}),"\n",(0,i.jsxs)(n.li,{children:["Click on your ",(0,i.jsx)(n.strong,{children:"profile menu"})," (top-right corner) and select ",(0,i.jsx)(n.strong,{children:"Console"}),"."]}),"\n",(0,i.jsxs)(n.li,{children:["From the ",(0,i.jsx)(n.strong,{children:"left sidebar"}),", choose ",(0,i.jsx)(n.strong,{children:"General"}),"."]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["You\u2019ll now be on the ",(0,i.jsx)(n.strong,{children:"General Settings"})," page."]}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:["\ud83d\udd12 ",(0,i.jsx)(n.strong,{children:"Note:"})," The ",(0,i.jsx)(n.strong,{children:"General Settings"})," page is available only to ",(0,i.jsx)(n.strong,{children:"Admin users"}),". Regular users will not see this option in their menu."]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"enabled-signature-types",children:"Enabled Signature Types"}),"\n",(0,i.jsx)(n.p,{children:"Admins can define which signature types are available across the organization."}),"\n",(0,i.jsxs)(n.p,{children:["All users under your account will only have access to the signature methods you enable here in their ",(0,i.jsx)(n.strong,{children:"Preferences"}),". Any disabled methods will be hidden from their options."]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Example:"}),(0,i.jsx)(n.br,{}),"\n","If Adam, the admin of your organization, disables the ",(0,i.jsx)(n.strong,{children:"Typed"})," signature type in the ",(0,i.jsx)(n.strong,{children:"Manage Signature Types"})," section, Ursula (a team member) will no longer see the ",(0,i.jsx)(n.strong,{children:"Typed"})," signature option in her preferences."]}),"\n",(0,i.jsxs)(n.p,{children:["However, Ursula can still enable or disable any of the remaining signature types for each document she creates.",(0,i.jsx)(n.br,{}),"\n","When she sends a document to Sofia (a signer), Sofia will only be able to use the signature methods that Ursula selected during the document setup."]}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Note:"})," Managing ",(0,i.jsx)(n.strong,{children:"Signature Types"})," at the organization level is available in the Teams and Enterprise plans.",(0,i.jsx)(n.br,{}),"\n","This feature is not included in the ",(0,i.jsx)(n.strong,{children:"Professional"})," or ",(0,i.jsx)(n.strong,{children:"Free"})," plans."]}),"\n"]}),"\n",(0,i.jsx)("img",{width:"918",alt:"General settings",src:"https://github.com/user-attachments/assets/60681095-6e53-4667-9f47-b3d4d38ab4b3"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"allow-indexing-of-public-profile",children:"Allow Indexing of Public Profile"}),"\n",(0,i.jsx)(n.p,{children:"When this option is enabled, user's public profiles will be indexed by search engines and may appear in search results."}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"email-template-customization",children:"Email Template Customization"}),"\n",(0,i.jsx)(n.p,{children:"This setting determines whether team members can create and manage their own email templates."}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["If ",(0,i.jsx)(n.strong,{children:"disabled"}),", users ",(0,i.jsx)(n.strong,{children:"cannot"})," create or modify custom templates for signature requests or completion notifications."]}),"\n",(0,i.jsxs)(n.li,{children:["If ",(0,i.jsx)(n.strong,{children:"enabled"}),", users can design and manage their own personalized email templates."]}),"\n"]}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsxs)(n.p,{children:["Need help? ",(0,i.jsx)(n.a,{href:"https://discord.com/invite/xe9TDuyAyj",children:"Join our Discord community"})," for instant support."]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},28453:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>l});var t=s(96540);const i={},r=t.createContext(i);function o(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4acb0154.cc896e9f.js b/assets/js/4acb0154.cc896e9f.js new file mode 100644 index 000000000..1dec3c085 --- /dev/null +++ b/assets/js/4acb0154.cc896e9f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[791],{5859:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>l,default:()=>h,frontMatter:()=>o,metadata:()=>i,toc:()=>c});const i=JSON.parse('{"id":"help/User Menu/Console/general","title":"General","description":"The General Settings section in OpenSign provides key administrative settings to help you manage and control the overall configuration of your OpenSign platform.","source":"@site/docs/help/User Menu/Console/general.md","sourceDirName":"help/User Menu/Console","slug":"/help/User Menu/Console/general","permalink":"/docs/help/User Menu/Console/general","draft":false,"unlisted":false,"editUrl":"https://github.com/opensignlabs/opensign/tree/feat-docs/docs/docs/help/User Menu/Console/general.md","tags":[],"version":"current","sidebarPosition":2,"frontMatter":{"sidebar_position":2,"title":"General"},"sidebar":"tutorialSidebar","previous":{"title":"Analytics","permalink":"/docs/help/User Menu/Console/analystics"},"next":{"title":"Branding","permalink":"/docs/help/User Menu/Console/branding"}}');var t=s(74848),r=s(28453);const o={sidebar_position:2,title:"General"},l="General Settings",a={},c=[{value:"\ud83d\ude80 How to Access the General Settings Page",id:"-how-to-access-the-general-settings-page",level:2},{value:"Enabled Signature Types",id:"enabled-signature-types",level:2},{value:"Allow Indexing of Public Profile",id:"allow-indexing-of-public-profile",level:2},{value:"Email Template Customization",id:"email-template-customization",level:2},{value:"Enable Individual User SMTP Settings",id:"enable-individual-user-smtp-settings",level:3}];function d(e){const n={a:"a",blockquote:"blockquote",br:"br",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"general-settings",children:"General Settings"})}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.strong,{children:"General Settings"})," section in OpenSign provides key administrative settings to help you manage and control the overall configuration of your OpenSign platform."]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"-how-to-access-the-general-settings-page",children:"\ud83d\ude80 How to Access the General Settings Page"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Log in to your ",(0,t.jsx)(n.strong,{children:"OpenSign"})," account using an ",(0,t.jsx)(n.strong,{children:"Admin account"}),"."]}),"\n",(0,t.jsxs)(n.li,{children:["Click on your ",(0,t.jsx)(n.strong,{children:"profile menu"})," (top-right corner) and select ",(0,t.jsx)(n.strong,{children:"Console"}),"."]}),"\n",(0,t.jsxs)(n.li,{children:["From the ",(0,t.jsx)(n.strong,{children:"left sidebar"}),", choose ",(0,t.jsx)(n.strong,{children:"General"}),"."]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["You\u2019ll now be on the ",(0,t.jsx)(n.strong,{children:"General Settings"})," page."]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:["\ud83d\udd12 ",(0,t.jsx)(n.strong,{children:"Note:"})," The ",(0,t.jsx)(n.strong,{children:"General Settings"})," page is available only to ",(0,t.jsx)(n.strong,{children:"Admin users"}),". Regular users will not see this option in their menu."]}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"enabled-signature-types",children:"Enabled Signature Types"}),"\n",(0,t.jsx)(n.p,{children:"Admins can define which signature types are available across the organization."}),"\n",(0,t.jsxs)(n.p,{children:["All users under your account will only have access to the signature methods you enable here in their ",(0,t.jsx)(n.strong,{children:"Preferences"}),". Any disabled methods will be hidden from their options."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Example:"}),(0,t.jsx)(n.br,{}),"\n","If Adam, the admin of your organization, disables the ",(0,t.jsx)(n.strong,{children:"Typed"})," signature type in the ",(0,t.jsx)(n.strong,{children:"Manage Signature Types"})," section, Ursula (a team member) will no longer see the ",(0,t.jsx)(n.strong,{children:"Typed"})," signature option in her preferences."]}),"\n",(0,t.jsxs)(n.p,{children:["However, Ursula can still enable or disable any of the remaining signature types for each document she creates.",(0,t.jsx)(n.br,{}),"\n","When she sends a document to Sofia (a signer), Sofia will only be able to use the signature methods that Ursula selected during the document setup."]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Note:"})," Managing ",(0,t.jsx)(n.strong,{children:"Signature Types"})," at the organization level is available in the Teams and Enterprise plans.",(0,t.jsx)(n.br,{}),"\n","This feature is not included in the ",(0,t.jsx)(n.strong,{children:"Professional"})," or ",(0,t.jsx)(n.strong,{children:"Free"})," plans."]}),"\n"]}),"\n",(0,t.jsx)("img",{width:"918",alt:"General settings",src:"https://github.com/user-attachments/assets/60681095-6e53-4667-9f47-b3d4d38ab4b3"}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"allow-indexing-of-public-profile",children:"Allow Indexing of Public Profile"}),"\n",(0,t.jsx)(n.p,{children:"When this option is enabled, user's public profiles will be indexed by search engines and may appear in search results."}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"email-template-customization",children:"Email Template Customization"}),"\n",(0,t.jsx)(n.p,{children:"This setting determines whether team members can create and manage their own email templates."}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["If ",(0,t.jsx)(n.strong,{children:"Disabled"}),": users ",(0,t.jsx)(n.strong,{children:"cannot"})," create or modify custom templates for signature requests or completion notifications."]}),"\n",(0,t.jsxs)(n.li,{children:["If ",(0,t.jsx)(n.strong,{children:"Enabled"}),": users can design and manage their own personalized email templates."]}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"enable-individual-user-smtp-settings",children:"Enable Individual User SMTP Settings"}),"\n",(0,t.jsxs)(n.p,{children:["This setting controls whether individual users are allowed to configure their own outgoing email servers (like connecting Gmail or using a custom SMTP).\nIf ",(0,t.jsx)(n.strong,{children:"Disabled"}),": Users CANNOT connect Gmail or configure custom SMTP at their level.\nIf ",(0,t.jsx)(n.strong,{children:"Enabled"}),": Users CAN connect Gmail or configure custom SMTP at their level."]}),"\n",(0,t.jsx)(n.p,{children:"Note: If users do not configure their own settings, all outgoing emails will be sent using the organization-level SMTP (if configured), or the OpenSign default SMTP if not."}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsxs)(n.p,{children:["Need help? ",(0,t.jsx)(n.a,{href:"https://discord.com/invite/xe9TDuyAyj",children:"Join our Discord community"})," for instant support."]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},28453:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>l});var i=s(96540);const t={},r=i.createContext(t);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6bef026b.3c18a97c.js b/assets/js/6bef026b.3c18a97c.js new file mode 100644 index 000000000..3e96d958d --- /dev/null +++ b/assets/js/6bef026b.3c18a97c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4952],{28453:(e,n,s)=>{s.d(n,{R:()=>l,x:()=>a});var i=s(96540);const t={},r=i.createContext(t);function l(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),i.createElement(r.Provider,{value:n},e.children)}},74094:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>l,metadata:()=>i,toc:()=>c});const i=JSON.parse('{"id":"help/Settings/Preferences","title":"Preferences","description":"The Preferences page in OpenSign\u2122 allows users and administrators to tailor the signing experience to suit individual, team, or organizational needs. Below is a breakdown of all configurable options and what they control.","source":"@site/docs/help/Settings/Preferences.md","sourceDirName":"help/Settings","slug":"/help/Settings/Preferences","permalink":"/docs/help/Settings/Preferences","draft":false,"unlisted":false,"editUrl":"https://github.com/opensignlabs/opensign/tree/feat-docs/docs/docs/help/Settings/Preferences.md","tags":[],"version":"current","sidebarPosition":4,"frontMatter":{"sidebar_position":4,"title":"Preferences"},"sidebar":"tutorialSidebar","previous":{"title":"Webhook","permalink":"/docs/help/Settings/Webhook"},"next":{"title":"Manage Teams","permalink":"/docs/help/Settings/Teams"}}');var t=s(74848),r=s(28453);const l={sidebar_position:4,title:"Preferences"},a="\ud83d\udd27 Preferences",o={},c=[{value:"\ud83d\ude80 Steps to Navigate to Preferences",id:"-steps-to-navigate-to-preferences",level:2},{value:"\ud83d\udccc Signature Types Control",id:"-signature-types-control",level:2},{value:"\ud83d\udd04 Multi-Level Signature Type Control",id:"-multi-level-signature-type-control",level:2},{value:"\ud83c\udfe2 Organization-Level",id:"-organization-level",level:3},{value:"\ud83d\udc64 User-Level",id:"-user-level",level:3},{value:"\ud83d\udcc4 Document-Level",id:"-document-level",level:3},{value:"\ud83d\udd14 Notify on Signatures",id:"-notify-on-signatures",level:2},{value:"\ud83d\udcec Send in Order",id:"-send-in-order",level:2},{value:"\ud83d\udeab Enable Tour",id:"-enable-tour",level:2},{value:"\ud83d\udce7 Custom SMTP Configuration in OpenSign",id:"-custom-smtp-configuration-in-opensign",level:3},{value:"\ud83d\udc64 SMTP at the User Level",id:"-smtp-at-the-user-level",level:2},{value:"To set up and enable user-level SMTP:",id:"to-set-up-and-enable-user-level-smtp",level:3},{value:"\ud83d\udd17 Connect to Gmail",id:"-connect-to-gmail",level:3},{value:"\u2699\ufe0f Custom SMTP",id:"\ufe0f-custom-smtp",level:3},{value:"\ud83d\udce4 OpenSign\u2122 Default SMTP",id:"-opensign-default-smtp",level:3},{value:"\ud83e\udded Timezone & Date Format",id:"-timezone--date-format",level:2},{value:"\ud83d\udcc5 Date Format",id:"-date-format",level:3},{value:"\ud83d\udd52 Time Format",id:"-time-format",level:3},{value:"\ud83e\uddea LTV-Enabled Signatures",id:"-ltv-enabled-signatures",level:2},{value:"\ud83d\udd10 Key Features:",id:"-key-features",level:3},{value:"\ud83d\udccc Why It Matters:",id:"-why-it-matters",level:3},{value:"\u2705 Use Cases:",id:"-use-cases",level:3},{value:"Merge Certificate to PDF",id:"merge-certificate-to-pdf",level:3},{value:"\ud83d\udd04 Multi-Level Custom Email Templates",id:"-multi-level-custom-email-templates",level:2},{value:"\ud83c\udfe2 Organization Level",id:"-organization-level-1",level:3},{value:"\ud83d\udc64 User Level",id:"-user-level-1",level:3},{value:"How Request-Signature and Completion Email Templates Work",id:"how-request-signature-and-completion-email-templates-work",level:3},{value:"\ud83d\udd12 Security",id:"-security",level:2},{value:"\ud83e\udde9 Features Available:",id:"-features-available",level:3},{value:"\u2705 Two-Factor Authentication (2FA)",id:"-two-factor-authentication-2fa",level:4},{value:"\ud83d\udee1\ufe0f Passkey Authentication",id:"\ufe0f-passkey-authentication",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",br:"br",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",img:"img",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"-preferences",children:"\ud83d\udd27 Preferences"})}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.strong,{children:"Preferences"})," page in ",(0,t.jsx)(n.strong,{children:"OpenSign\u2122"})," allows users and administrators to tailor the signing experience to suit individual, team, or organizational needs. Below is a breakdown of all configurable options and what they control."]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"-steps-to-navigate-to-preferences",children:"\ud83d\ude80 Steps to Navigate to Preferences"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Step 1:"})," Log in to your OpenSign account using valid credentials."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Step 2:"})," Navigate to the ",(0,t.jsx)(n.strong,{children:"Settings"})," section and click on ",(0,t.jsx)(n.strong,{children:"Preferences"}),"."]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"-signature-types-control",children:"\ud83d\udccc Signature Types Control"}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.strong,{children:"Allowed Signature Types"})," section defines which signature methods are available to signers:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["\u2705 ",(0,t.jsx)(n.strong,{children:"Draw"}),": Create a handwritten signature using a mouse, stylus, or finger."]}),"\n",(0,t.jsxs)(n.li,{children:["\u2705 ",(0,t.jsx)(n.strong,{children:"Type"}),": Type your name and apply it using pre-set font styles."]}),"\n",(0,t.jsxs)(n.li,{children:["\u2705 ",(0,t.jsx)(n.strong,{children:"Upload"}),": Upload a scanned or saved image of your signature."]}),"\n",(0,t.jsxs)(n.li,{children:["\u2705 ",(0,t.jsx)(n.strong,{children:"Default"}),": Use the default signature stored under ",(0,t.jsx)(n.em,{children:"My Signature"})," in settings."]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"\u2699\ufe0f The options selected here determine what appears in the signature widget during document creation and signing. You can also change these preferences while creating a document."}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"-multi-level-signature-type-control",children:"\ud83d\udd04 Multi-Level Signature Type Control"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"OpenSign\u2122"})," introduces flexible control over signature options at three levels:"]}),"\n",(0,t.jsx)(n.h3,{id:"-organization-level",children:"\ud83c\udfe2 Organization-Level"}),"\n",(0,t.jsx)(n.p,{children:"Admins can enforce company-wide signing policies by restricting available signature methods platform-wide."}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Step 1:"})," Open the profile menu and select ",(0,t.jsx)(n.strong,{children:"Console Application"})," to launch the console."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Step 2:"})," Once the Console Application loads, navigate to the ",(0,t.jsx)(n.strong,{children:"General"})," menu. Here, admins can configure the allowed signature types at the organization level."]}),"\n",(0,t.jsxs)(n.p,{children:["All users created under your account will only see the signing methods you enable here in their ",(0,t.jsx)(n.strong,{children:"Preferences"}),". They will be restricted from using any methods you don't select."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Example:"}),(0,t.jsx)(n.br,{}),"\n","Adam, the administrator of your company account, disables the ",(0,t.jsx)(n.strong,{children:"Typed"})," signature option in the ",(0,t.jsx)(n.strong,{children:"Manage Signature Types"})," settings. As a result, Ursula, a team member, will no longer see the ",(0,t.jsx)(n.strong,{children:"Typed"})," signature option in her preferences."]}),"\n",(0,t.jsx)(n.p,{children:"Ursula can enable or disable any of the remaining three signature methods for each document she creates."}),"\n",(0,t.jsx)(n.p,{children:"When she sends a document to Sofia, a signer, Sofia will only see the signature methods that Ursula selected during the document creation process."}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Note:"})," Managing ",(0,t.jsx)(n.strong,{children:"Signature Types"})," at the organization level is only available on the ",(0,t.jsx)(n.strong,{children:"Teams"})," plan. This feature is not included in the ",(0,t.jsx)(n.strong,{children:"Professional"})," or ",(0,t.jsx)(n.strong,{children:"Free"})," plans."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/c8c3de19-e82e-464a-977b-cdf3fd12aed7",alt:"Signature type setup console"})}),"\n",(0,t.jsx)(n.h3,{id:"-user-level",children:"\ud83d\udc64 User-Level"}),"\n",(0,t.jsxs)(n.p,{children:["Navigate to ",(0,t.jsx)(n.strong,{children:"Settings > Preferences"})," to configure user-level signature types."]}),"\n",(0,t.jsx)(n.p,{children:"If a user sets preferred types here, only those will appear when adding signature or initial widgets during document creation."}),"\n",(0,t.jsx)("img",{width:"861",height:"480",alt:"signatures",src:"https://github.com/user-attachments/assets/69d0851c-57f2-42e5-af6e-419f6d8821c2"}),"\n",(0,t.jsx)(n.h3,{id:"-document-level",children:"\ud83d\udcc4 Document-Level"}),"\n",(0,t.jsx)(n.p,{children:"While creating a document, users can specify allowed signature types."}),"\n",(0,t.jsx)(n.p,{children:"Only these will be available to the signer\u2014useful for legal or regulatory requirements."}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/d64510e1-df14-44fe-8020-45b17c612238",alt:"Signature type setup signature widget"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"-notify-on-signatures",children:"\ud83d\udd14 Notify on Signatures"}),"\n",(0,t.jsx)(n.p,{children:"The document owner can choose to receive email notifications when a document is signed."}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Yes"})," \u2013 Get notified each time a signer completes their part."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"No"})," \u2013 Turn off real-time signature notifications."]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"This setting can be adjusted while creating a document or template."}),"\n",(0,t.jsxs)(n.p,{children:["Regardless of this preference, a ",(0,t.jsx)(n.strong,{children:"final completion email"}),"\u2014including the signed document and completion certificate\u2014is ",(0,t.jsx)(n.strong,{children:"always sent"})," to both the document owner and all signers."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Note:"})," Notify on Signatures feature is only available on the ",(0,t.jsx)(n.strong,{children:"Professional"})," and higher plans\u2014it is not included in the ",(0,t.jsx)(n.strong,{children:"Free"})," plan."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/5adad567-6c01-4766-9b10-db3f95ad65d3",alt:"Preferences setup"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"-send-in-order",children:"\ud83d\udcec Send in Order"}),"\n",(0,t.jsxs)(n.p,{children:["Decide whether the document should be signed ",(0,t.jsx)(n.strong,{children:"sequentially"})," or ",(0,t.jsx)(n.strong,{children:"simultaneously"})," by multiple signers."]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Yes"})," \u2013 Signers receive the document in a set order. The next signer gains access only after the previous one completes signing."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"No"})," \u2013 All signers receive the document at once and can sign independently."]}),"\n"]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsx)(n.p,{children:"Users can change this option while creating the document or a template."}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"-enable-tour",children:"\ud83d\udeab Enable Tour"}),"\n",(0,t.jsx)(n.p,{children:"The tour feature provides guidance for first-time users. You can turn this off for a cleaner, uninterrupted experience:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Yes"})," \u2013 Show onboarding tips. Enables guided tooltips for the signer during the signing process."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"No"})," \u2013 Disable tour prompts ",(0,t.jsx)(n.em,{children:"(recommended for experienced users)"}),". Speeds up the signing experience."]}),"\n"]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsx)(n.p,{children:"Users can change this option while creating the document or a template."}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["\ud83d\udca1 ",(0,t.jsx)(n.strong,{children:"Tip"}),": Disable if your users are already familiar with OpenSign\u2122."]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"-custom-smtp-configuration-in-opensign",children:"\ud83d\udce7 Custom SMTP Configuration in OpenSign"}),"\n",(0,t.jsxs)(n.p,{children:["OpenSign allows users to ",(0,t.jsx)(n.strong,{children:"send emails using their own SMTP settings"}),", including Gmail integration or third-party SMTP providers.",(0,t.jsx)(n.br,{}),"\n","OpenSign now supports SMTP configuration at both the ",(0,t.jsx)(n.strong,{children:"organization level"})," and the ",(0,t.jsx)(n.strong,{children:"individual user level"}),"."]}),"\n",(0,t.jsx)(n.h2,{id:"-smtp-at-the-user-level",children:"\ud83d\udc64 SMTP at the User Level"}),"\n",(0,t.jsxs)(n.p,{children:["Users can configure their own SMTP settings to send request-signature and completion emails using their personal mailbox.\nThese user-level settings will override the organization-level SMTP only if the admin has ",(0,t.jsx)(n.strong,{children:"enabled individual SMTP customization"})," under Console \u2192 General."]}),"\n",(0,t.jsx)(n.p,{children:"Use this option if you prefer sending emails directly from your own email address."}),"\n",(0,t.jsx)(n.h3,{id:"to-set-up-and-enable-user-level-smtp",children:"To set up and enable user-level SMTP:"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Go to ",(0,t.jsx)(n.strong,{children:"Settings"})]}),"\n",(0,t.jsxs)(n.li,{children:["Select ",(0,t.jsx)(n.strong,{children:"Preferences"})]}),"\n",(0,t.jsx)(n.li,{children:"Choose one of the available SMTP options."}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Once a user selects and configures any SMTP option, all emails will be sent using the user-level SMTP."}),"\n",(0,t.jsx)("img",{width:"861",height:"409",alt:"smtp at user level",src:"https://github.com/user-attachments/assets/27c459f3-5ae6-41e8-966d-43785e67f192"}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"-connect-to-gmail",children:"\ud83d\udd17 Connect to Gmail"}),"\n",(0,t.jsxs)(n.p,{children:["Send request-signature emails directly from your ",(0,t.jsx)(n.strong,{children:"Gmail account"}),"."]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Click ",(0,t.jsx)(n.strong,{children:"Connect to Gmail"})]}),"\n",(0,t.jsx)(n.li,{children:"A popup will appear prompting you to sign in"}),"\n",(0,t.jsx)(n.li,{children:"Grant the required access permissions"}),"\n",(0,t.jsx)(n.li,{children:"Once authorized, OpenSign will send emails using your Gmail account"}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"\ufe0f-custom-smtp",children:"\u2699\ufe0f Custom SMTP"}),"\n",(0,t.jsx)(n.p,{children:"Configure any third-party SMTP provider such as SMTP2GO or Mailgun."}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Click ",(0,t.jsx)(n.strong,{children:"Custom SMTP"})]}),"\n",(0,t.jsxs)(n.li,{children:["A popup will appear asking for your SMTP details:","\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Host:"})," SMTP server host (e.g., ",(0,t.jsx)(n.code,{children:"mail.smtp2go.com"}),")"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Port:"})," SMTP port (e.g., ",(0,t.jsx)(n.code,{children:"2525"}),")"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Sender Email:"})," Email address configured in your SMTP account"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Username:"})," SMTP username"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Password:"})," SMTP password"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,t.jsx)("img",{width:"820",alt:"Custom smtp",src:"https://github.com/user-attachments/assets/a3c33510-11b9-4a32-bd44-99614182b089"}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"-opensign-default-smtp",children:"\ud83d\udce4 OpenSign\u2122 Default SMTP"}),"\n",(0,t.jsx)(n.p,{children:"If selected, all request-signature and completion emails will be sent using OpenSign\u2019s built-in SMTP server."}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.p,{children:"If the user does not configure any SMTP option, emails will be sent using the organization-level SMTP (when it is enabled by the admin).\nIf the admin has configured a company-level SMTP, and the user has not set up their own SMTP, the user will still be connected to the default OpenSign SMTP, but all outgoing emails will be delivered using the organization-level SMTP."}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:["\u26a0\ufe0f ",(0,t.jsx)(n.strong,{children:"Notes:"})]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["A green checkmark indicates the ",(0,t.jsx)(n.strong,{children:"active SMTP option"}),"."]}),"\n",(0,t.jsx)(n.li,{children:"Only one SMTP option can be active at a time."}),"\n",(0,t.jsx)(n.li,{children:"User-level SMTP is available only when permitted by the admin."}),"\n",(0,t.jsxs)(n.li,{children:["Some SMTP features are limited to ",(0,t.jsx)(n.strong,{children:"Paid plans"}),"."]}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"-timezone--date-format",children:"\ud83e\udded Timezone & Date Format"}),"\n",(0,t.jsxs)(n.p,{children:["Customize the ",(0,t.jsx)(n.strong,{children:"Timezone"})," and ",(0,t.jsx)(n.strong,{children:"Date Format"})," according to your regional preferences.",(0,t.jsx)(n.br,{}),"\n","These settings are reflected in:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"Document Completion Certificates"}),"\n",(0,t.jsx)(n.li,{children:"Signing Logs"}),"\n",(0,t.jsx)(n.li,{children:"Webhooks"}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"-date-format",children:"\ud83d\udcc5 Date Format"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"The selected date format will be applied by default to the date widget if no specific format is chosen during document creation."}),"\n",(0,t.jsx)(n.li,{children:"This default format also applies in all API flows."}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"-time-format",children:"\ud83d\udd52 Time Format"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Supports ",(0,t.jsx)(n.strong,{children:"12-hour"})," and ",(0,t.jsx)(n.strong,{children:"24-hour"})," formats."]}),"\n",(0,t.jsx)(n.li,{children:"Affects timestamps in certificates, logs, and webhooks."}),"\n"]}),"\n",(0,t.jsx)("img",{width:"820",alt:"Time zone",src:"https://github.com/user-attachments/assets/bc1f29a2-565a-4ac2-96a4-9aa18b80b064"}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"-ltv-enabled-signatures",children:"\ud83e\uddea LTV-Enabled Signatures"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"LTV (Long-Term Validation)"})," ensures that signatures remain valid and verifiable even after certificates expire or are revoked."]}),"\n",(0,t.jsx)(n.h3,{id:"-key-features",children:"\ud83d\udd10 Key Features:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"Embeds certificate chain"}),"\n",(0,t.jsx)(n.li,{children:"Includes CRLs and OCSP responses"}),"\n",(0,t.jsx)(n.li,{children:"Enables offline verification"}),"\n",(0,t.jsxs)(n.li,{children:["Complies with PDF standards like ",(0,t.jsx)(n.strong,{children:"PAdES"})]}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"-why-it-matters",children:"\ud83d\udccc Why It Matters:"}),"\n",(0,t.jsx)(n.p,{children:"Even if a certificate becomes invalid in the future, the LTV-enabled signature remains verifiable."}),"\n",(0,t.jsx)(n.h3,{id:"-use-cases",children:"\u2705 Use Cases:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"Legal Contracts"}),"\n",(0,t.jsx)(n.li,{children:"Financial or Medical Records"}),"\n",(0,t.jsx)(n.li,{children:"Long-term archiving requirements"}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"merge-certificate-to-pdf",children:(0,t.jsx)(n.strong,{children:"Merge Certificate to PDF"})}),"\n",(0,t.jsxs)(n.p,{children:["You can access this option by navigating to ",(0,t.jsx)(n.strong,{children:"Settings \u2192 Preferences"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Yes:"})," Selecting ",(0,t.jsx)(n.strong,{children:"Yes"})," will attach the completion certificate directly to the signed document, creating a single combined PDF file.",(0,t.jsx)(n.br,{}),"\n","Please note that once merged, the certificate cannot be separated from the main document."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"No:"})," Selecting ",(0,t.jsx)(n.strong,{children:"No"})," will keep the completion certificate as a separate PDF file, which will be downloaded along with the signed document."]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Note:"})," This feature is available only in the ",(0,t.jsx)(n.strong,{children:"paid plans"})," of OpenSign."]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"-multi-level-custom-email-templates",children:"\ud83d\udd04 Multi-Level Custom Email Templates"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"OpenSign\u2122"})," offers flexible control over email templates at two different levels:"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"-organization-level-1",children:"\ud83c\udfe2 Organization Level"}),"\n",(0,t.jsx)(n.p,{children:"Admins can manage and enforce standardized email templates across the entire platform."}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Step 1:"})," Open the profile menu and select ",(0,t.jsx)(n.strong,{children:"Console Application"})," to access the admin console.",(0,t.jsx)(n.br,{}),"\n",(0,t.jsx)(n.strong,{children:"Step 2:"})," Once the Console Application opens, go to the ",(0,t.jsx)(n.strong,{children:"Mail"})," section. Here, administrators can configure email templates at the organization level."]}),"\n",(0,t.jsxs)(n.p,{children:["All users created under your organization will automatically use these templates for sending request-signature and document completion emails ",(0,t.jsx)(n.strong,{children:"unless"})," they have permission to create templates at the individual level or have customized their own templates."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Example:"}),(0,t.jsx)(n.br,{}),"\n","Adam, the administrator of your company account, disables the ",(0,t.jsx)(n.strong,{children:"Allow email template customization for users individually"})," setting under ",(0,t.jsx)(n.strong,{children:"Console \u2192 General"}),". As a result, Ursula, a team member, cannot create or modify her own email templates."]}),"\n",(0,t.jsxs)(n.p,{children:["When Ursula sends a document to Sofia for signing, Sofia will receive the organization-level email template.",(0,t.jsx)(n.br,{}),"\n","If Adam enables ",(0,t.jsx)(n.strong,{children:"Allow email template customization for users individually"})," but Ursula does not set up her own template, the signers will still receive emails based on the organization-level template."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Note:"})," Organization-level email management is available only on ",(0,t.jsx)(n.strong,{children:"Paid"})," plans. This feature is ",(0,t.jsx)(n.strong,{children:"not"})," included in ",(0,t.jsx)(n.strong,{children:"Free"})," plans."]}),"\n",(0,t.jsx)("img",{width:"861",height:"409",alt:"Email_templates",src:"https://github.com/user-attachments/assets/0b15e356-cfba-46d5-9e97-c73d32b879f4"}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"-user-level-1",children:"\ud83d\udc64 User Level"}),"\n",(0,t.jsxs)(n.p,{children:["Users can configure their own email templates by navigating to ",(0,t.jsx)(n.strong,{children:"Settings \u2192 Preferences"}),"."]}),"\n",(0,t.jsx)(n.p,{children:"If a user sets up templates here, those templates will be used for sending request-signature emails and document-completion emails."}),"\n",(0,t.jsx)("img",{width:"861",height:"480",alt:"signatures",src:"https://github.com/user-attachments/assets/dda05d4f-aa43-435d-bdb2-e68dca6f2b00"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Note:"})," Customize email management is only available on ",(0,t.jsx)(n.strong,{children:"Paid"})," plans. This feature is not included in ",(0,t.jsx)(n.strong,{children:"Free"})," plans."]}),"\n",(0,t.jsx)(n.h3,{id:"how-request-signature-and-completion-email-templates-work",children:"How Request-Signature and Completion Email Templates Work"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["If the admin enables ",(0,t.jsx)(n.strong,{children:"Allow email template customization for users individually"})," and the user sets up their own custom templates, then both ",(0,t.jsx)(n.strong,{children:"request-signature emails"})," and ",(0,t.jsx)(n.strong,{children:"completion emails"})," will be sent using the ",(0,t.jsx)(n.strong,{children:"user-level templates"}),"."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["If the user does ",(0,t.jsx)(n.strong,{children:"not"})," set up custom templates, and the admin has also ",(0,t.jsx)(n.strong,{children:"not"})," configured templates at the organization level, then the ",(0,t.jsx)(n.strong,{children:"default OpenSign templates"})," will be used."]}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"-security",children:"\ud83d\udd12 Security"}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.strong,{children:"Security"})," tab in OpenSign (found under ",(0,t.jsx)(n.strong,{children:"Settings > Preferences > Security"}),") allows users to manage key authentication methods to protect their account access."]}),"\n",(0,t.jsx)(n.h3,{id:"-features-available",children:"\ud83e\udde9 Features Available:"}),"\n",(0,t.jsx)(n.h4,{id:"-two-factor-authentication-2fa",children:"\u2705 Two-Factor Authentication (2FA)"}),"\n",(0,t.jsx)(n.p,{children:"Enhance your account security by enabling 2FA. Once activated, you'll enter a time-based code from an authenticator app each time you log in."}),"\n",(0,t.jsx)(n.h4,{id:"\ufe0f-passkey-authentication",children:"\ud83d\udee1\ufe0f Passkey Authentication"}),"\n",(0,t.jsxs)(n.p,{children:["Passkeys offer a ",(0,t.jsx)(n.strong,{children:"passwordless"}),", ",(0,t.jsx)(n.strong,{children:"phishing-resistant"})," login experience using your device\u2019s built-in security features such as fingerprint, Face ID, or PIN."]}),"\n",(0,t.jsxs)(n.p,{children:["\ud83d\udc49 For full details on setting up ",(0,t.jsx)(n.strong,{children:"Two-Factor Authentication (2FA)"})," and ",(0,t.jsx)(n.strong,{children:"Passkey Authentication"}),":",(0,t.jsx)(n.br,{}),"\n",(0,t.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/Settings/SecurityManagement",children:"\ud83d\udd12 View Security Setup Guide"})]}),"\n",(0,t.jsxs)(n.p,{children:["For more assistance with OpenSign\u2122 features or APIs, contact our support team at ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.a,{href:"mailto:support@opensignlabs.com",children:"support@opensignlabs.com"})}),"."]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}}}]); \ No newline at end of file diff --git a/assets/js/6bef026b.9462a6b2.js b/assets/js/6bef026b.9462a6b2.js deleted file mode 100644 index 34448df34..000000000 --- a/assets/js/6bef026b.9462a6b2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4952],{28453:(e,n,s)=>{s.d(n,{R:()=>l,x:()=>a});var i=s(96540);const t={},r=i.createContext(t);function l(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),i.createElement(r.Provider,{value:n},e.children)}},74094:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>h,frontMatter:()=>l,metadata:()=>i,toc:()=>c});const i=JSON.parse('{"id":"help/Settings/Preferences","title":"Preferences","description":"The Preferences page in OpenSign\u2122 allows users and administrators to tailor the signing experience to suit individual, team, or organizational needs. Below is a breakdown of all configurable options and what they control.","source":"@site/docs/help/Settings/Preferences.md","sourceDirName":"help/Settings","slug":"/help/Settings/Preferences","permalink":"/docs/help/Settings/Preferences","draft":false,"unlisted":false,"editUrl":"https://github.com/opensignlabs/opensign/tree/feat-docs/docs/docs/help/Settings/Preferences.md","tags":[],"version":"current","sidebarPosition":4,"frontMatter":{"sidebar_position":4,"title":"Preferences"},"sidebar":"tutorialSidebar","previous":{"title":"Webhook","permalink":"/docs/help/Settings/Webhook"},"next":{"title":"Manage Teams","permalink":"/docs/help/Settings/Teams"}}');var t=s(74848),r=s(28453);const l={sidebar_position:4,title:"Preferences"},a="\ud83d\udd27 Preferences",o={},c=[{value:"\ud83d\ude80 Steps to Navigate to Preferences",id:"-steps-to-navigate-to-preferences",level:2},{value:"\ud83d\udccc Signature Types Control",id:"-signature-types-control",level:2},{value:"\ud83d\udd04 Multi-Level Signature Type Control",id:"-multi-level-signature-type-control",level:2},{value:"\ud83c\udfe2 Organization-Level",id:"-organization-level",level:3},{value:"\ud83d\udc64 User-Level",id:"-user-level",level:3},{value:"\ud83d\udcc4 Document-Level",id:"-document-level",level:3},{value:"\ud83d\udd14 Notify on Signatures",id:"-notify-on-signatures",level:2},{value:"\ud83d\udcec Send in Order",id:"-send-in-order",level:2},{value:"\ud83d\udeab Enable Tour",id:"-enable-tour",level:2},{value:"\ud83d\udce7 Custom SMTP Configuration in OpenSign",id:"-custom-smtp-configuration-in-opensign",level:3},{value:"\ud83c\udfe2 SMTP at the Organization Level",id:"-smtp-at-the-organization-level",level:2},{value:"How to Set Up SMTP at the Organization Level",id:"how-to-set-up-smtp-at-the-organization-level",level:3},{value:"\ud83d\udd17 Connect to Gmail",id:"-connect-to-gmail",level:3},{value:"\u2699\ufe0f Custom SMTP",id:"\ufe0f-custom-smtp",level:3},{value:"\ud83d\udce4 OpenSign\u2122 Default SMTP",id:"-opensign-default-smtp",level:3},{value:"\ud83d\udc64 SMTP at the User Level",id:"-smtp-at-the-user-level",level:2},{value:"To set up and enable user-level SMTP:",id:"to-set-up-and-enable-user-level-smtp",level:3},{value:"\ud83e\udded Timezone & Date Format",id:"-timezone--date-format",level:2},{value:"\ud83d\udcc5 Date Format",id:"-date-format",level:3},{value:"\ud83d\udd52 Time Format",id:"-time-format",level:3},{value:"\ud83e\uddea LTV-Enabled Signatures",id:"-ltv-enabled-signatures",level:2},{value:"\ud83d\udd10 Key Features:",id:"-key-features",level:3},{value:"\ud83d\udccc Why It Matters:",id:"-why-it-matters",level:3},{value:"\u2705 Use Cases:",id:"-use-cases",level:3},{value:"Merge Certificate to PDF",id:"merge-certificate-to-pdf",level:3},{value:"\ud83d\udd04 Multi-Level Custom Email Templates",id:"-multi-level-custom-email-templates",level:2},{value:"\ud83c\udfe2 Organization Level",id:"-organization-level-1",level:3},{value:"\ud83d\udc64 User Level",id:"-user-level-1",level:3},{value:"How Request-Signature and Completion Email Templates Work",id:"how-request-signature-and-completion-email-templates-work",level:3},{value:"\ud83d\udd12 Security",id:"-security",level:2},{value:"\ud83e\udde9 Features Available:",id:"-features-available",level:3},{value:"\u2705 Two-Factor Authentication (2FA)",id:"-two-factor-authentication-2fa",level:4},{value:"\ud83d\udee1\ufe0f Passkey Authentication",id:"\ufe0f-passkey-authentication",level:4}];function d(e){const n={a:"a",blockquote:"blockquote",br:"br",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",img:"img",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"-preferences",children:"\ud83d\udd27 Preferences"})}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.strong,{children:"Preferences"})," page in ",(0,t.jsx)(n.strong,{children:"OpenSign\u2122"})," allows users and administrators to tailor the signing experience to suit individual, team, or organizational needs. Below is a breakdown of all configurable options and what they control."]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"-steps-to-navigate-to-preferences",children:"\ud83d\ude80 Steps to Navigate to Preferences"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Step 1:"})," Log in to your OpenSign account using valid credentials."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Step 2:"})," Navigate to the ",(0,t.jsx)(n.strong,{children:"Settings"})," section and click on ",(0,t.jsx)(n.strong,{children:"Preferences"}),"."]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"-signature-types-control",children:"\ud83d\udccc Signature Types Control"}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.strong,{children:"Allowed Signature Types"})," section defines which signature methods are available to signers:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["\u2705 ",(0,t.jsx)(n.strong,{children:"Draw"}),": Create a handwritten signature using a mouse, stylus, or finger."]}),"\n",(0,t.jsxs)(n.li,{children:["\u2705 ",(0,t.jsx)(n.strong,{children:"Type"}),": Type your name and apply it using pre-set font styles."]}),"\n",(0,t.jsxs)(n.li,{children:["\u2705 ",(0,t.jsx)(n.strong,{children:"Upload"}),": Upload a scanned or saved image of your signature."]}),"\n",(0,t.jsxs)(n.li,{children:["\u2705 ",(0,t.jsx)(n.strong,{children:"Default"}),": Use the default signature stored under ",(0,t.jsx)(n.em,{children:"My Signature"})," in settings."]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"\u2699\ufe0f The options selected here determine what appears in the signature widget during document creation and signing. You can also change these preferences while creating a document."}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"-multi-level-signature-type-control",children:"\ud83d\udd04 Multi-Level Signature Type Control"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"OpenSign\u2122"})," introduces flexible control over signature options at three levels:"]}),"\n",(0,t.jsx)(n.h3,{id:"-organization-level",children:"\ud83c\udfe2 Organization-Level"}),"\n",(0,t.jsx)(n.p,{children:"Admins can enforce company-wide signing policies by restricting available signature methods platform-wide."}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Step 1:"})," Open the profile menu and select ",(0,t.jsx)(n.strong,{children:"Console Application"})," to launch the console."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Step 2:"})," Once the Console Application loads, navigate to the ",(0,t.jsx)(n.strong,{children:"General"})," menu. Here, admins can configure the allowed signature types at the organization level."]}),"\n",(0,t.jsxs)(n.p,{children:["All users created under your account will only see the signing methods you enable here in their ",(0,t.jsx)(n.strong,{children:"Preferences"}),". They will be restricted from using any methods you don't select."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Example:"}),(0,t.jsx)(n.br,{}),"\n","Adam, the administrator of your company account, disables the ",(0,t.jsx)(n.strong,{children:"Typed"})," signature option in the ",(0,t.jsx)(n.strong,{children:"Manage Signature Types"})," settings. As a result, Ursula, a team member, will no longer see the ",(0,t.jsx)(n.strong,{children:"Typed"})," signature option in her preferences."]}),"\n",(0,t.jsx)(n.p,{children:"Ursula can enable or disable any of the remaining three signature methods for each document she creates."}),"\n",(0,t.jsx)(n.p,{children:"When she sends a document to Sofia, a signer, Sofia will only see the signature methods that Ursula selected during the document creation process."}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Note:"})," Managing ",(0,t.jsx)(n.strong,{children:"Signature Types"})," at the organization level is only available on the ",(0,t.jsx)(n.strong,{children:"Teams"})," plan. This feature is not included in the ",(0,t.jsx)(n.strong,{children:"Professional"})," or ",(0,t.jsx)(n.strong,{children:"Free"})," plans."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/c8c3de19-e82e-464a-977b-cdf3fd12aed7",alt:"Signature type setup console"})}),"\n",(0,t.jsx)(n.h3,{id:"-user-level",children:"\ud83d\udc64 User-Level"}),"\n",(0,t.jsxs)(n.p,{children:["Navigate to ",(0,t.jsx)(n.strong,{children:"Settings > Preferences"})," to configure user-level signature types."]}),"\n",(0,t.jsx)(n.p,{children:"If a user sets preferred types here, only those will appear when adding signature or initial widgets during document creation."}),"\n",(0,t.jsx)("img",{width:"861",height:"480",alt:"signatures",src:"https://github.com/user-attachments/assets/69d0851c-57f2-42e5-af6e-419f6d8821c2"}),"\n",(0,t.jsx)(n.h3,{id:"-document-level",children:"\ud83d\udcc4 Document-Level"}),"\n",(0,t.jsx)(n.p,{children:"While creating a document, users can specify allowed signature types."}),"\n",(0,t.jsx)(n.p,{children:"Only these will be available to the signer\u2014useful for legal or regulatory requirements."}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/d64510e1-df14-44fe-8020-45b17c612238",alt:"Signature type setup signature widget"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"-notify-on-signatures",children:"\ud83d\udd14 Notify on Signatures"}),"\n",(0,t.jsx)(n.p,{children:"The document owner can choose to receive email notifications when a document is signed."}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Yes"})," \u2013 Get notified each time a signer completes their part."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"No"})," \u2013 Turn off real-time signature notifications."]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"This setting can be adjusted while creating a document or template."}),"\n",(0,t.jsxs)(n.p,{children:["Regardless of this preference, a ",(0,t.jsx)(n.strong,{children:"final completion email"}),"\u2014including the signed document and completion certificate\u2014is ",(0,t.jsx)(n.strong,{children:"always sent"})," to both the document owner and all signers."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Note:"})," Notify on Signatures feature is only available on the ",(0,t.jsx)(n.strong,{children:"Professional"})," and higher plans\u2014it is not included in the ",(0,t.jsx)(n.strong,{children:"Free"})," plan."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:"https://github.com/user-attachments/assets/5adad567-6c01-4766-9b10-db3f95ad65d3",alt:"Preferences setup"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"-send-in-order",children:"\ud83d\udcec Send in Order"}),"\n",(0,t.jsxs)(n.p,{children:["Decide whether the document should be signed ",(0,t.jsx)(n.strong,{children:"sequentially"})," or ",(0,t.jsx)(n.strong,{children:"simultaneously"})," by multiple signers."]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Yes"})," \u2013 Signers receive the document in a set order. The next signer gains access only after the previous one completes signing."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"No"})," \u2013 All signers receive the document at once and can sign independently."]}),"\n"]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsx)(n.p,{children:"Users can change this option while creating the document or a template."}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"-enable-tour",children:"\ud83d\udeab Enable Tour"}),"\n",(0,t.jsx)(n.p,{children:"The tour feature provides guidance for first-time users. You can turn this off for a cleaner, uninterrupted experience:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Yes"})," \u2013 Show onboarding tips. Enables guided tooltips for the signer during the signing process."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"No"})," \u2013 Disable tour prompts ",(0,t.jsx)(n.em,{children:"(recommended for experienced users)"}),". Speeds up the signing experience."]}),"\n"]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsx)(n.p,{children:"Users can change this option while creating the document or a template."}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["\ud83d\udca1 ",(0,t.jsx)(n.strong,{children:"Tip"}),": Disable if your users are already familiar with OpenSign\u2122."]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"-custom-smtp-configuration-in-opensign",children:"\ud83d\udce7 Custom SMTP Configuration in OpenSign"}),"\n",(0,t.jsxs)(n.p,{children:["OpenSign allows users to ",(0,t.jsx)(n.strong,{children:"send emails using their own SMTP settings"}),", including Gmail integration or third-party SMTP providers.",(0,t.jsx)(n.br,{}),"\n","OpenSign now supports SMTP configuration at both the ",(0,t.jsx)(n.strong,{children:"organization level"})," and the ",(0,t.jsx)(n.strong,{children:"individual user level"}),"."]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"-smtp-at-the-organization-level",children:"\ud83c\udfe2 SMTP at the Organization Level"}),"\n",(0,t.jsxs)(n.p,{children:["Configure SMTP at the organization level to send all outgoing emails\u2014such as request-signature and completion emails\u2014using a company-configured SMTP server.",(0,t.jsx)(n.br,{}),"\n","When enabled, these settings apply to all users ",(0,t.jsx)(n.strong,{children:"unless individual SMTP customization is allowed and set up by the user"}),"."]}),"\n",(0,t.jsx)(n.h3,{id:"how-to-set-up-smtp-at-the-organization-level",children:"How to Set Up SMTP at the Organization Level"}),"\n",(0,t.jsx)(n.p,{children:"Admins can manage and enforce SMTP settings across the entire platform."}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Step 1:"})," Open the profile menu and select ",(0,t.jsx)(n.strong,{children:"Console Application"})," to access the admin console.",(0,t.jsx)(n.br,{}),"\n",(0,t.jsx)(n.strong,{children:"Step 2:"})," In the Console, navigate to the ",(0,t.jsx)(n.strong,{children:"Global SMTP"})," section and configure your SMTP settings."]}),"\n",(0,t.jsxs)(n.p,{children:["All users under your organization will automatically use the organization-level SMTP ",(0,t.jsx)(n.strong,{children:"unless"})," they are allowed to configure their own SMTP settings."]}),"\n",(0,t.jsx)("img",{width:"861",height:"409",alt:"Global SMTP",src:"https://github.com/user-attachments/assets/fe9dc091-59dd-47f9-992a-811cecaac2f3"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Example:"}),(0,t.jsx)(n.br,{}),"\n","Adam, the administrator, disables ",(0,t.jsx)(n.strong,{children:"Enable individual user SMTP settings"})," under ",(0,t.jsx)(n.strong,{children:"Console \u2192 General"}),".",(0,t.jsx)(n.br,{}),"\n","As a result, Ursula cannot configure her own SMTP."]}),"\n",(0,t.jsxs)(n.p,{children:["When Ursula sends a document to Sofia for signing, Sofia receives emails sent through the ",(0,t.jsx)(n.strong,{children:"organization-level SMTP"}),".",(0,t.jsx)(n.br,{}),"\n","If Adam enables ",(0,t.jsx)(n.strong,{children:"Enable individual user SMTP settings"}),", but Ursula does not configure her own SMTP, emails will still be sent using the ",(0,t.jsx)(n.strong,{children:"organization-level SMTP"}),"."]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Note:"})," Organization-level SMTP configuration is available ",(0,t.jsx)(n.strong,{children:"only on Paid plans"})," and is not included in ",(0,t.jsx)(n.strong,{children:"Free"})," plans."]}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"-connect-to-gmail",children:"\ud83d\udd17 Connect to Gmail"}),"\n",(0,t.jsxs)(n.p,{children:["Send request-signature emails directly from your ",(0,t.jsx)(n.strong,{children:"Gmail account"}),"."]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Click ",(0,t.jsx)(n.strong,{children:"Connect to Gmail"})]}),"\n",(0,t.jsx)(n.li,{children:"A popup will appear prompting you to sign in"}),"\n",(0,t.jsx)(n.li,{children:"Grant the required access permissions"}),"\n",(0,t.jsx)(n.li,{children:"Once authorized, OpenSign will send emails using your Gmail account"}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"\ufe0f-custom-smtp",children:"\u2699\ufe0f Custom SMTP"}),"\n",(0,t.jsx)(n.p,{children:"Configure any third-party SMTP provider such as SMTP2GO or Mailgun."}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Click ",(0,t.jsx)(n.strong,{children:"Custom SMTP"})]}),"\n",(0,t.jsxs)(n.li,{children:["A popup will appear asking for your SMTP details:","\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Host:"})," SMTP server host (e.g., ",(0,t.jsx)(n.code,{children:"mail.smtp2go.com"}),")"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Port:"})," SMTP port (e.g., ",(0,t.jsx)(n.code,{children:"2525"}),")"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Sender Email:"})," Email address configured in your SMTP account"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Username:"})," SMTP username"]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Password:"})," SMTP password"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,t.jsx)("img",{width:"820",alt:"Custom smtp",src:"https://github.com/user-attachments/assets/a3c33510-11b9-4a32-bd44-99614182b089"}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"-opensign-default-smtp",children:"\ud83d\udce4 OpenSign\u2122 Default SMTP"}),"\n",(0,t.jsx)(n.p,{children:"If selected, all request-signature and completion emails will be sent using OpenSign\u2019s built-in SMTP server."}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"-smtp-at-the-user-level",children:"\ud83d\udc64 SMTP at the User Level"}),"\n",(0,t.jsxs)(n.p,{children:["Users can configure their own SMTP settings to send request-signature and completion emails using their personal mailbox.\nThese user-level settings will override the organization-level SMTP only if the admin has ",(0,t.jsx)(n.strong,{children:"enabled individual SMTP customization"})," under Console \u2192 General."]}),"\n",(0,t.jsx)(n.p,{children:"Use this option if you prefer sending emails directly from your own email address."}),"\n",(0,t.jsx)(n.h3,{id:"to-set-up-and-enable-user-level-smtp",children:"To set up and enable user-level SMTP:"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Go to ",(0,t.jsx)(n.strong,{children:"Settings"})]}),"\n",(0,t.jsxs)(n.li,{children:["Select ",(0,t.jsx)(n.strong,{children:"Preferences"})]}),"\n",(0,t.jsx)(n.li,{children:"Choose one of the available SMTP options."}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Once a user selects and configures any SMTP option, all emails will be sent using the user-level SMTP."}),"\n",(0,t.jsx)("img",{width:"861",height:"409",alt:"smtp at user level",src:"https://github.com/user-attachments/assets/27c459f3-5ae6-41e8-966d-43785e67f192"}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.p,{children:"If the user does not configure any SMTP option, emails will be sent using the organization-level SMTP (when it is enabled by the admin).\nIf the admin has configured a company-level SMTP, and the user has not set up their own SMTP, the user will still be connected to the default OpenSign SMTP, but all outgoing emails will be delivered using the organization-level SMTP."}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:["\u26a0\ufe0f ",(0,t.jsx)(n.strong,{children:"Notes:"})]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["A green checkmark indicates the ",(0,t.jsx)(n.strong,{children:"active SMTP option"}),"."]}),"\n",(0,t.jsx)(n.li,{children:"Only one SMTP option can be active at a time."}),"\n",(0,t.jsx)(n.li,{children:"User-level SMTP is available only when permitted by the admin."}),"\n",(0,t.jsxs)(n.li,{children:["Some SMTP features are limited to ",(0,t.jsx)(n.strong,{children:"Paid plans"}),"."]}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"-timezone--date-format",children:"\ud83e\udded Timezone & Date Format"}),"\n",(0,t.jsxs)(n.p,{children:["Customize the ",(0,t.jsx)(n.strong,{children:"Timezone"})," and ",(0,t.jsx)(n.strong,{children:"Date Format"})," according to your regional preferences.",(0,t.jsx)(n.br,{}),"\n","These settings are reflected in:"]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"Document Completion Certificates"}),"\n",(0,t.jsx)(n.li,{children:"Signing Logs"}),"\n",(0,t.jsx)(n.li,{children:"Webhooks"}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"-date-format",children:"\ud83d\udcc5 Date Format"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"The selected date format will be applied by default to the date widget if no specific format is chosen during document creation."}),"\n",(0,t.jsx)(n.li,{children:"This default format also applies in all API flows."}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"-time-format",children:"\ud83d\udd52 Time Format"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Supports ",(0,t.jsx)(n.strong,{children:"12-hour"})," and ",(0,t.jsx)(n.strong,{children:"24-hour"})," formats."]}),"\n",(0,t.jsx)(n.li,{children:"Affects timestamps in certificates, logs, and webhooks."}),"\n"]}),"\n",(0,t.jsx)("img",{width:"820",alt:"Time zone",src:"https://github.com/user-attachments/assets/bc1f29a2-565a-4ac2-96a4-9aa18b80b064"}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"-ltv-enabled-signatures",children:"\ud83e\uddea LTV-Enabled Signatures"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"LTV (Long-Term Validation)"})," ensures that signatures remain valid and verifiable even after certificates expire or are revoked."]}),"\n",(0,t.jsx)(n.h3,{id:"-key-features",children:"\ud83d\udd10 Key Features:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"Embeds certificate chain"}),"\n",(0,t.jsx)(n.li,{children:"Includes CRLs and OCSP responses"}),"\n",(0,t.jsx)(n.li,{children:"Enables offline verification"}),"\n",(0,t.jsxs)(n.li,{children:["Complies with PDF standards like ",(0,t.jsx)(n.strong,{children:"PAdES"})]}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"-why-it-matters",children:"\ud83d\udccc Why It Matters:"}),"\n",(0,t.jsx)(n.p,{children:"Even if a certificate becomes invalid in the future, the LTV-enabled signature remains verifiable."}),"\n",(0,t.jsx)(n.h3,{id:"-use-cases",children:"\u2705 Use Cases:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"Legal Contracts"}),"\n",(0,t.jsx)(n.li,{children:"Financial or Medical Records"}),"\n",(0,t.jsx)(n.li,{children:"Long-term archiving requirements"}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"merge-certificate-to-pdf",children:(0,t.jsx)(n.strong,{children:"Merge Certificate to PDF"})}),"\n",(0,t.jsxs)(n.p,{children:["You can access this option by navigating to ",(0,t.jsx)(n.strong,{children:"Settings \u2192 Preferences"}),"."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Yes:"})," Selecting ",(0,t.jsx)(n.strong,{children:"Yes"})," will attach the completion certificate directly to the signed document, creating a single combined PDF file.",(0,t.jsx)(n.br,{}),"\n","Please note that once merged, the certificate cannot be separated from the main document."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"No:"})," Selecting ",(0,t.jsx)(n.strong,{children:"No"})," will keep the completion certificate as a separate PDF file, which will be downloaded along with the signed document."]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Note:"})," This feature is available only in the ",(0,t.jsx)(n.strong,{children:"paid plans"})," of OpenSign."]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"-multi-level-custom-email-templates",children:"\ud83d\udd04 Multi-Level Custom Email Templates"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"OpenSign\u2122"})," offers flexible control over email templates at two different levels:"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"-organization-level-1",children:"\ud83c\udfe2 Organization Level"}),"\n",(0,t.jsx)(n.p,{children:"Admins can manage and enforce standardized email templates across the entire platform."}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Step 1:"})," Open the profile menu and select ",(0,t.jsx)(n.strong,{children:"Console Application"})," to access the admin console.",(0,t.jsx)(n.br,{}),"\n",(0,t.jsx)(n.strong,{children:"Step 2:"})," Once the Console Application opens, go to the ",(0,t.jsx)(n.strong,{children:"Mail"})," section. Here, administrators can configure email templates at the organization level."]}),"\n",(0,t.jsxs)(n.p,{children:["All users created under your organization will automatically use these templates for sending request-signature and document completion emails ",(0,t.jsx)(n.strong,{children:"unless"})," they have permission to create templates at the individual level or have customized their own templates."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Example:"}),(0,t.jsx)(n.br,{}),"\n","Adam, the administrator of your company account, disables the ",(0,t.jsx)(n.strong,{children:"Allow email template customization for users individually"})," setting under ",(0,t.jsx)(n.strong,{children:"Console \u2192 General"}),". As a result, Ursula, a team member, cannot create or modify her own email templates."]}),"\n",(0,t.jsxs)(n.p,{children:["When Ursula sends a document to Sofia for signing, Sofia will receive the organization-level email template.",(0,t.jsx)(n.br,{}),"\n","If Adam enables ",(0,t.jsx)(n.strong,{children:"Allow email template customization for users individually"})," but Ursula does not set up her own template, the signers will still receive emails based on the organization-level template."]}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Note:"})," Organization-level email management is available only on ",(0,t.jsx)(n.strong,{children:"Paid"})," plans. This feature is ",(0,t.jsx)(n.strong,{children:"not"})," included in ",(0,t.jsx)(n.strong,{children:"Free"})," plans."]}),"\n",(0,t.jsx)("img",{width:"861",height:"409",alt:"Email_templates",src:"https://github.com/user-attachments/assets/0b15e356-cfba-46d5-9e97-c73d32b879f4"}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"-user-level-1",children:"\ud83d\udc64 User Level"}),"\n",(0,t.jsxs)(n.p,{children:["Users can configure their own email templates by navigating to ",(0,t.jsx)(n.strong,{children:"Settings \u2192 Preferences"}),"."]}),"\n",(0,t.jsx)(n.p,{children:"If a user sets up templates here, those templates will be used for sending request-signature emails and document-completion emails."}),"\n",(0,t.jsx)("img",{width:"861",height:"480",alt:"signatures",src:"https://github.com/user-attachments/assets/dda05d4f-aa43-435d-bdb2-e68dca6f2b00"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.strong,{children:"Note:"})," Customize email management is only available on ",(0,t.jsx)(n.strong,{children:"Paid"})," plans. This feature is not included in ",(0,t.jsx)(n.strong,{children:"Free"})," plans."]}),"\n",(0,t.jsx)(n.h3,{id:"how-request-signature-and-completion-email-templates-work",children:"How Request-Signature and Completion Email Templates Work"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["If the admin enables ",(0,t.jsx)(n.strong,{children:"Allow email template customization for users individually"})," and the user sets up their own custom templates, then both ",(0,t.jsx)(n.strong,{children:"request-signature emails"})," and ",(0,t.jsx)(n.strong,{children:"completion emails"})," will be sent using the ",(0,t.jsx)(n.strong,{children:"user-level templates"}),"."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["If the user does ",(0,t.jsx)(n.strong,{children:"not"})," set up custom templates, and the admin has also ",(0,t.jsx)(n.strong,{children:"not"})," configured templates at the organization level, then the ",(0,t.jsx)(n.strong,{children:"default OpenSign templates"})," will be used."]}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"-security",children:"\ud83d\udd12 Security"}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.strong,{children:"Security"})," tab in OpenSign (found under ",(0,t.jsx)(n.strong,{children:"Settings > Preferences > Security"}),") allows users to manage key authentication methods to protect their account access."]}),"\n",(0,t.jsx)(n.h3,{id:"-features-available",children:"\ud83e\udde9 Features Available:"}),"\n",(0,t.jsx)(n.h4,{id:"-two-factor-authentication-2fa",children:"\u2705 Two-Factor Authentication (2FA)"}),"\n",(0,t.jsx)(n.p,{children:"Enhance your account security by enabling 2FA. Once activated, you'll enter a time-based code from an authenticator app each time you log in."}),"\n",(0,t.jsx)(n.h4,{id:"\ufe0f-passkey-authentication",children:"\ud83d\udee1\ufe0f Passkey Authentication"}),"\n",(0,t.jsxs)(n.p,{children:["Passkeys offer a ",(0,t.jsx)(n.strong,{children:"passwordless"}),", ",(0,t.jsx)(n.strong,{children:"phishing-resistant"})," login experience using your device\u2019s built-in security features such as fingerprint, Face ID, or PIN."]}),"\n",(0,t.jsxs)(n.p,{children:["\ud83d\udc49 For full details on setting up ",(0,t.jsx)(n.strong,{children:"Two-Factor Authentication (2FA)"})," and ",(0,t.jsx)(n.strong,{children:"Passkey Authentication"}),":",(0,t.jsx)(n.br,{}),"\n",(0,t.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/help/Settings/SecurityManagement",children:"\ud83d\udd12 View Security Setup Guide"})]}),"\n",(0,t.jsxs)(n.p,{children:["For more assistance with OpenSign\u2122 features or APIs, contact our support team at ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.a,{href:"mailto:support@opensignlabs.com",children:"support@opensignlabs.com"})}),"."]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}}}]); \ No newline at end of file diff --git a/assets/js/c1e4445e.8e750522.js b/assets/js/c1e4445e.8e750522.js new file mode 100644 index 000000000..350c71df1 --- /dev/null +++ b/assets/js/c1e4445e.8e750522.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1170],{28453:(e,s,n)=>{n.d(s,{R:()=>i,x:()=>l});var o=n(96540);const t={},r=o.createContext(t);function i(e){const s=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function l(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),o.createElement(r.Provider,{value:s},e.children)}},52666:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>c,contentTitle:()=>l,default:()=>u,frontMatter:()=>i,metadata:()=>o,toc:()=>a});const o=JSON.parse('{"id":"help/User Menu/Console/custom_filestorage","title":"Custom File Storage","description":"\ud83c\udf29\ufe0f Introduction to BYOC (Bring Your Own Cloud)","source":"@site/docs/help/User Menu/Console/custom_filestorage.md","sourceDirName":"help/User Menu/Console","slug":"/help/User Menu/Console/custom_filestorage","permalink":"/docs/help/User Menu/Console/custom_filestorage","draft":false,"unlisted":false,"editUrl":"https://github.com/opensignlabs/opensign/tree/feat-docs/docs/docs/help/User Menu/Console/custom_filestorage.md","tags":[],"version":"current","sidebarPosition":5,"frontMatter":{"sidebar_position":5,"title":"Custom File Storage"},"sidebar":"tutorialSidebar","previous":{"title":"Preferences","permalink":"/docs/help/User Menu/Console/globalSMTP"},"next":{"title":"Email Templates","permalink":"/docs/help/User Menu/Console/emails"}}');var t=n(74848),r=n(28453);const i={sidebar_position:5,title:"Custom File Storage"},l="\ud83d\udcbe Custom File Storage",c={},a=[{value:"\ud83c\udf29\ufe0f Introduction to BYOC (Bring Your Own Cloud)",id:"\ufe0f-introduction-to-byoc-bring-your-own-cloud",level:2},{value:"\ud83d\ude80 How to Access the Custom File Storage Setup",id:"-how-to-access-the-custom-file-storage-setup",level:2},{value:"\ud83d\udd14 Set Up File Storage",id:"-set-up-file-storage",level:2},{value:"\ud83e\udea3 Steps to Configure Custom Storage",id:"-steps-to-configure-custom-storage",level:3},{value:"\u26a0\ufe0f Important Note",id:"\ufe0f-important-note",level:3},{value:"\ud83d\udcac Need Help?",id:"-need-help",level:2}];function d(e){const s={a:"a",blockquote:"blockquote",br:"br",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.header,{children:(0,t.jsx)(s.h1,{id:"-custom-file-storage",children:"\ud83d\udcbe Custom File Storage"})}),"\n",(0,t.jsx)(s.h2,{id:"\ufe0f-introduction-to-byoc-bring-your-own-cloud",children:"\ud83c\udf29\ufe0f Introduction to BYOC (Bring Your Own Cloud)"}),"\n",(0,t.jsxs)(s.p,{children:["OpenSign supports ",(0,t.jsx)(s.strong,{children:"BYOC (Bring Your Own Cloud)"})," \u2014 allowing you to ",(0,t.jsx)(s.strong,{children:"store your documents in your own cloud storage"})," instead of OpenSign\u2019s default storage."]}),"\n",(0,t.jsxs)(s.p,{children:["With BYOC, organizations and users gain ",(0,t.jsx)(s.strong,{children:"greater control, privacy, and compliance flexibility"})," by connecting their preferred cloud providers such as ",(0,t.jsx)(s.strong,{children:"AWS S3"})," or ",(0,t.jsx)(s.strong,{children:"DigitalOcean Spaces"}),"."]}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:["\ud83e\udde0 ",(0,t.jsx)(s.strong,{children:"Why BYOC?"})]}),"\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsx)(s.li,{children:"Maintain complete ownership and control of your documents."}),"\n",(0,t.jsx)(s.li,{children:"Comply with internal, regional, or client-specific data policies."}),"\n",(0,t.jsx)(s.li,{children:"Choose your preferred cloud region or provider for better performance and compliance."}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h2,{id:"-how-to-access-the-custom-file-storage-setup",children:"\ud83d\ude80 How to Access the Custom File Storage Setup"}),"\n",(0,t.jsxs)(s.p,{children:["Follow the steps below to navigate to the ",(0,t.jsx)(s.strong,{children:"Custom File Storage"})," setup page in OpenSign:"]}),"\n",(0,t.jsxs)(s.ol,{children:["\n",(0,t.jsxs)(s.li,{children:["Log in to your ",(0,t.jsx)(s.strong,{children:"OpenSign"})," account using an ",(0,t.jsx)(s.strong,{children:"Admin account"}),"."]}),"\n",(0,t.jsxs)(s.li,{children:["Click on your ",(0,t.jsx)(s.strong,{children:"profile menu"})," (top-right corner) and select ",(0,t.jsx)(s.strong,{children:"Console"}),"."]}),"\n",(0,t.jsxs)(s.li,{children:["In the ",(0,t.jsx)(s.strong,{children:"left sidebar"}),", go to ",(0,t.jsx)(s.strong,{children:"Storage"}),"."]}),"\n"]}),"\n",(0,t.jsx)("img",{width:"1722",height:"814",alt:"Custom file storage",src:"https://github.com/user-attachments/assets/813f6685-3f36-40e4-aaaf-0d8b86bdc3b7"}),"\n",(0,t.jsxs)(s.p,{children:["You will now be on the ",(0,t.jsx)(s.strong,{children:"Custom File Storage"})," setup page where you can configure your own storage provider."]}),"\n",(0,t.jsxs)(s.blockquote,{children:["\n",(0,t.jsxs)(s.p,{children:["\ud83d\udd12 ",(0,t.jsx)(s.strong,{children:"Note:"})," Access to Custom File Storage settings is available only to ",(0,t.jsx)(s.strong,{children:"Admin users"}),". Regular users will not see this option in their menu."]}),"\n"]}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h2,{id:"-set-up-file-storage",children:"\ud83d\udd14 Set Up File Storage"}),"\n",(0,t.jsxs)(s.p,{children:["By default, all users are connected to ",(0,t.jsx)(s.strong,{children:"OpenSign\u2019s default file storage"}),".",(0,t.jsx)(s.br,{}),"\n","If you prefer to use your ",(0,t.jsx)(s.strong,{children:"own custom cloud storage (BYOC)"}),", you can easily configure it here."]}),"\n",(0,t.jsxs)(s.p,{children:["You can set up an ",(0,t.jsx)(s.strong,{children:"AWS S3 bucket"})," or ",(0,t.jsx)(s.strong,{children:"DigitalOcean Space"})," to store your uploaded documents securely.",(0,t.jsx)(s.br,{}),"\n","To configure OpenSign with your cloud storage, refer to this detailed guide:",(0,t.jsx)(s.br,{}),"\n","\ud83d\udc49 ",(0,t.jsx)(s.a,{href:"https://docs.opensignlabs.com/docs/self-host/cloud-storage/s3",children:"Cloud Storage Setup Guide"})]}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"-steps-to-configure-custom-storage",children:"\ud83e\udea3 Steps to Configure Custom Storage"}),"\n",(0,t.jsxs)(s.ol,{children:["\n",(0,t.jsxs)(s.li,{children:["Click the ",(0,t.jsx)(s.strong,{children:"Add New"})," button."]}),"\n"]}),"\n",(0,t.jsx)("img",{width:"861",height:"408",alt:"Add new workspace",src:"https://github.com/user-attachments/assets/0f734c6a-e2ac-445a-8194-746b9c202f0a"}),"\n",(0,t.jsxs)(s.ol,{start:"2",children:["\n",(0,t.jsxs)(s.li,{children:["\n",(0,t.jsx)(s.p,{children:"Fill in the following details:"}),"\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.strong,{children:"Unique File Adapter Name:"})," Enter a unique name for your storage configuration."]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.strong,{children:"Storage Provider:"})," Choose your provider \u2014 currently, OpenSign supports ",(0,t.jsx)(s.strong,{children:"AWS S3"})," and ",(0,t.jsx)(s.strong,{children:"DigitalOcean Spaces"}),"."]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.strong,{children:"Bucket Name:"})," Specify your storage bucket name."]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.strong,{children:"Region:"})," Enter the region where your bucket is hosted."]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.strong,{children:"Endpoint:"})," Provide the endpoint URL of your storage service."]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.strong,{children:"Base URL:"})," Enter the base URL used to access stored files."]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.strong,{children:"Access Key ID:"})," Enter your storage access key ID."]}),"\n",(0,t.jsxs)(s.li,{children:[(0,t.jsx)(s.strong,{children:"Secret Access Key:"})," Enter your storage secret access key."]}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(s.li,{children:["\n",(0,t.jsxs)(s.p,{children:["Once all details are filled, click ",(0,t.jsx)(s.strong,{children:"Save and Activate"})," to enable your custom file storage."]}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(s.p,{children:"After activation:"}),"\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsxs)(s.li,{children:["All your documents will be stored in the configured ",(0,t.jsx)(s.strong,{children:"BYOC storage provider"}),"."]}),"\n",(0,t.jsx)(s.li,{children:"You will be automatically logged out to clear any previous file adapter data from your local session."}),"\n",(0,t.jsx)(s.li,{children:"Upon logging in again, your custom file storage will be active, and all future documents will be saved there."}),"\n"]}),"\n",(0,t.jsx)("img",{width:"861",height:"408",alt:"custom file storage",src:"https://github.com/user-attachments/assets/1add417d-f745-4e00-8cf3-7dcd9798f4db"}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h3,{id:"\ufe0f-important-note",children:"\u26a0\ufe0f Important Note"}),"\n",(0,t.jsxs)(s.p,{children:["In some cases, documents stored in your ",(0,t.jsx)(s.strong,{children:"custom (BYOC)"})," file storage may not load in OpenSign due to ",(0,t.jsx)(s.strong,{children:"CORS (Cross-Origin Resource Sharing)"})," policy restrictions.",(0,t.jsx)(s.br,{}),"\n","If you\u2019ve activated custom file storage, ensure your cloud configuration ",(0,t.jsx)(s.strong,{children:"allows OpenSign to access your documents"})," and does ",(0,t.jsx)(s.strong,{children:"not block requests"})," due to CORS errors."]}),"\n",(0,t.jsxs)(s.p,{children:["\ud83d\udc49 ",(0,t.jsx)(s.a,{href:"https://docs.opensignlabs.com/docs/self-host/cloud-storage/s3",children:"Read the article to learn how to set up CORS policies"})]}),"\n",(0,t.jsx)(s.hr,{}),"\n",(0,t.jsx)(s.h2,{id:"-need-help",children:"\ud83d\udcac Need Help?"}),"\n",(0,t.jsxs)(s.p,{children:["If you need help setting up or testing your BYOC or custom file storage integration, contact our support team at",(0,t.jsx)(s.br,{}),"\n","\ud83d\udce9 ",(0,t.jsx)(s.strong,{children:(0,t.jsx)(s.a,{href:"mailto:support@opensignlabs.com",children:"support@opensignlabs.com"})})]}),"\n",(0,t.jsxs)(s.p,{children:["Or join our community for instant assistance:",(0,t.jsx)(s.br,{}),"\n","\ud83d\udcac ",(0,t.jsx)(s.a,{href:"https://discord.com/invite/xe9TDuyAyj",children:"Join our Discord"})]}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.strong,{children:"Happy Signing with OpenSign\u2122!"})})]})}function u(e={}){const{wrapper:s}={...(0,r.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}}}]); \ No newline at end of file diff --git a/assets/js/c1e4445e.ca7f10f3.js b/assets/js/c1e4445e.ca7f10f3.js deleted file mode 100644 index 63de3f1d1..000000000 --- a/assets/js/c1e4445e.ca7f10f3.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1170],{28453:(e,n,s)=>{s.d(n,{R:()=>i,x:()=>l});var o=s(96540);const t={},r=o.createContext(t);function i(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),o.createElement(r.Provider,{value:n},e.children)}},52666:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>u,frontMatter:()=>i,metadata:()=>o,toc:()=>a});const o=JSON.parse('{"id":"help/User Menu/Console/custom_filestorage","title":"Custom File Storage","description":"\ud83c\udf29\ufe0f Introduction to BYOC (Bring Your Own Cloud)","source":"@site/docs/help/User Menu/Console/custom_filestorage.md","sourceDirName":"help/User Menu/Console","slug":"/help/User Menu/Console/custom_filestorage","permalink":"/docs/help/User Menu/Console/custom_filestorage","draft":false,"unlisted":false,"editUrl":"https://github.com/opensignlabs/opensign/tree/feat-docs/docs/docs/help/User Menu/Console/custom_filestorage.md","tags":[],"version":"current","sidebarPosition":5,"frontMatter":{"sidebar_position":5,"title":"Custom File Storage"},"sidebar":"tutorialSidebar","previous":{"title":"Branding","permalink":"/docs/help/User Menu/Console/branding"},"next":{"title":"Email Templates","permalink":"/docs/help/User Menu/Console/emails"}}');var t=s(74848),r=s(28453);const i={sidebar_position:5,title:"Custom File Storage"},l="\ud83d\udcbe Custom File Storage",c={},a=[{value:"\ud83c\udf29\ufe0f Introduction to BYOC (Bring Your Own Cloud)",id:"\ufe0f-introduction-to-byoc-bring-your-own-cloud",level:2},{value:"\ud83d\ude80 How to Access the Custom File Storage Setup",id:"-how-to-access-the-custom-file-storage-setup",level:2},{value:"\ud83d\udd14 Set Up File Storage",id:"-set-up-file-storage",level:2},{value:"\ud83e\udea3 Steps to Configure Custom Storage",id:"-steps-to-configure-custom-storage",level:3},{value:"\u26a0\ufe0f Important Note",id:"\ufe0f-important-note",level:3},{value:"\ud83d\udcac Need Help?",id:"-need-help",level:2}];function d(e){const n={a:"a",blockquote:"blockquote",br:"br",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"-custom-file-storage",children:"\ud83d\udcbe Custom File Storage"})}),"\n",(0,t.jsx)(n.h2,{id:"\ufe0f-introduction-to-byoc-bring-your-own-cloud",children:"\ud83c\udf29\ufe0f Introduction to BYOC (Bring Your Own Cloud)"}),"\n",(0,t.jsxs)(n.p,{children:["OpenSign supports ",(0,t.jsx)(n.strong,{children:"BYOC (Bring Your Own Cloud)"})," \u2014 allowing you to ",(0,t.jsx)(n.strong,{children:"store your documents in your own cloud storage"})," instead of OpenSign\u2019s default storage."]}),"\n",(0,t.jsxs)(n.p,{children:["With BYOC, organizations and users gain ",(0,t.jsx)(n.strong,{children:"greater control, privacy, and compliance flexibility"})," by connecting their preferred cloud providers such as ",(0,t.jsx)(n.strong,{children:"AWS S3"})," or ",(0,t.jsx)(n.strong,{children:"DigitalOcean Spaces"}),"."]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:["\ud83e\udde0 ",(0,t.jsx)(n.strong,{children:"Why BYOC?"})]}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"Maintain complete ownership and control of your documents."}),"\n",(0,t.jsx)(n.li,{children:"Comply with internal, regional, or client-specific data policies."}),"\n",(0,t.jsx)(n.li,{children:"Choose your preferred cloud region or provider for better performance and compliance."}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"-how-to-access-the-custom-file-storage-setup",children:"\ud83d\ude80 How to Access the Custom File Storage Setup"}),"\n",(0,t.jsxs)(n.p,{children:["Follow the steps below to navigate to the ",(0,t.jsx)(n.strong,{children:"Custom File Storage"})," setup page in OpenSign:"]}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Log in to your ",(0,t.jsx)(n.strong,{children:"OpenSign"})," account using an ",(0,t.jsx)(n.strong,{children:"Admin account"}),"."]}),"\n",(0,t.jsxs)(n.li,{children:["Click on your ",(0,t.jsx)(n.strong,{children:"profile menu"})," (top-right corner) and select ",(0,t.jsx)(n.strong,{children:"Console"}),"."]}),"\n",(0,t.jsxs)(n.li,{children:["In the ",(0,t.jsx)(n.strong,{children:"left sidebar"}),", go to ",(0,t.jsx)(n.strong,{children:"Storage"}),"."]}),"\n"]}),"\n",(0,t.jsx)("img",{width:"1722",height:"814",alt:"Custom file storage",src:"https://github.com/user-attachments/assets/813f6685-3f36-40e4-aaaf-0d8b86bdc3b7"}),"\n",(0,t.jsxs)(n.p,{children:["You will now be on the ",(0,t.jsx)(n.strong,{children:"Custom File Storage"})," setup page where you can configure your own storage provider."]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:["\ud83d\udd12 ",(0,t.jsx)(n.strong,{children:"Note:"})," Access to Custom File Storage settings is available only to ",(0,t.jsx)(n.strong,{children:"Admin users"}),". Regular users will not see this option in their menu."]}),"\n"]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"-set-up-file-storage",children:"\ud83d\udd14 Set Up File Storage"}),"\n",(0,t.jsxs)(n.p,{children:["By default, all users are connected to ",(0,t.jsx)(n.strong,{children:"OpenSign\u2019s default file storage"}),".",(0,t.jsx)(n.br,{}),"\n","If you prefer to use your ",(0,t.jsx)(n.strong,{children:"own custom cloud storage (BYOC)"}),", you can easily configure it here."]}),"\n",(0,t.jsxs)(n.p,{children:["You can set up an ",(0,t.jsx)(n.strong,{children:"AWS S3 bucket"})," or ",(0,t.jsx)(n.strong,{children:"DigitalOcean Space"})," to store your uploaded documents securely.",(0,t.jsx)(n.br,{}),"\n","To configure OpenSign with your cloud storage, refer to this detailed guide:",(0,t.jsx)(n.br,{}),"\n","\ud83d\udc49 ",(0,t.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/self-host/cloud-storage/s3",children:"Cloud Storage Setup Guide"})]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"-steps-to-configure-custom-storage",children:"\ud83e\udea3 Steps to Configure Custom Storage"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Click the ",(0,t.jsx)(n.strong,{children:"Add New"})," button."]}),"\n"]}),"\n",(0,t.jsx)("img",{width:"861",height:"408",alt:"Add new workspace",src:"https://github.com/user-attachments/assets/0f734c6a-e2ac-445a-8194-746b9c202f0a"}),"\n",(0,t.jsxs)(n.ol,{start:"2",children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Fill in the following details:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Unique File Adapter Name:"})," Enter a unique name for your storage configuration."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Storage Provider:"})," Choose your provider \u2014 currently, OpenSign supports ",(0,t.jsx)(n.strong,{children:"AWS S3"})," and ",(0,t.jsx)(n.strong,{children:"DigitalOcean Spaces"}),"."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Bucket Name:"})," Specify your storage bucket name."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Region:"})," Enter the region where your bucket is hosted."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Endpoint:"})," Provide the endpoint URL of your storage service."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Base URL:"})," Enter the base URL used to access stored files."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Access Key ID:"})," Enter your storage access key ID."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Secret Access Key:"})," Enter your storage secret access key."]}),"\n"]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["Once all details are filled, click ",(0,t.jsx)(n.strong,{children:"Save and Activate"})," to enable your custom file storage."]}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"After activation:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["All your documents will be stored in the configured ",(0,t.jsx)(n.strong,{children:"BYOC storage provider"}),"."]}),"\n",(0,t.jsx)(n.li,{children:"You will be automatically logged out to clear any previous file adapter data from your local session."}),"\n",(0,t.jsx)(n.li,{children:"Upon logging in again, your custom file storage will be active, and all future documents will be saved there."}),"\n"]}),"\n",(0,t.jsx)("img",{width:"861",height:"408",alt:"custom file storage",src:"https://github.com/user-attachments/assets/1add417d-f745-4e00-8cf3-7dcd9798f4db"}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"\ufe0f-important-note",children:"\u26a0\ufe0f Important Note"}),"\n",(0,t.jsxs)(n.p,{children:["In some cases, documents stored in your ",(0,t.jsx)(n.strong,{children:"custom (BYOC)"})," file storage may not load in OpenSign due to ",(0,t.jsx)(n.strong,{children:"CORS (Cross-Origin Resource Sharing)"})," policy restrictions.",(0,t.jsx)(n.br,{}),"\n","If you\u2019ve activated custom file storage, ensure your cloud configuration ",(0,t.jsx)(n.strong,{children:"allows OpenSign to access your documents"})," and does ",(0,t.jsx)(n.strong,{children:"not block requests"})," due to CORS errors."]}),"\n",(0,t.jsxs)(n.p,{children:["\ud83d\udc49 ",(0,t.jsx)(n.a,{href:"https://docs.opensignlabs.com/docs/self-host/cloud-storage/s3",children:"Read the article to learn how to set up CORS policies"})]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"-need-help",children:"\ud83d\udcac Need Help?"}),"\n",(0,t.jsxs)(n.p,{children:["If you need help setting up or testing your BYOC or custom file storage integration, contact our support team at",(0,t.jsx)(n.br,{}),"\n","\ud83d\udce9 ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.a,{href:"mailto:support@opensignlabs.com",children:"support@opensignlabs.com"})})]}),"\n",(0,t.jsxs)(n.p,{children:["Or join our community for instant assistance:",(0,t.jsx)(n.br,{}),"\n","\ud83d\udcac ",(0,t.jsx)(n.a,{href:"https://discord.com/invite/xe9TDuyAyj",children:"Join our Discord"})]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Happy Signing with OpenSign\u2122!"})})]})}function u(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}}}]); \ No newline at end of file diff --git a/assets/js/dc8c216b.5259eacc.js b/assets/js/dc8c216b.5259eacc.js deleted file mode 100644 index e4c4483ee..000000000 --- a/assets/js/dc8c216b.5259eacc.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9144],{28453:(e,n,s)=>{s.d(n,{R:()=>i,x:()=>a});var t=s(96540);const o={},r=t.createContext(o);function i(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),t.createElement(r.Provider,{value:n},e.children)}},89073:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>p,frontMatter:()=>i,metadata:()=>t,toc:()=>c});const t=JSON.parse('{"id":"help/User Menu/Console/branding","title":"Branding","description":"Custom Subdomain","source":"@site/docs/help/User Menu/Console/branding.md","sourceDirName":"help/User Menu/Console","slug":"/help/User Menu/Console/branding","permalink":"/docs/help/User Menu/Console/branding","draft":false,"unlisted":false,"editUrl":"https://github.com/opensignlabs/opensign/tree/feat-docs/docs/docs/help/User Menu/Console/branding.md","tags":[],"version":"current","sidebarPosition":4,"frontMatter":{"sidebar_position":4,"title":"Branding"},"sidebar":"tutorialSidebar","previous":{"title":"General","permalink":"/docs/help/User Menu/Console/general"},"next":{"title":"Custom File Storage","permalink":"/docs/help/User Menu/Console/custom_filestorage"}}');var o=s(74848),r=s(28453);const i={sidebar_position:4,title:"Branding"},a="\ud83d\udd27 Branding",l={},c=[{value:"Custom Subdomain",id:"custom-subdomain",level:2},{value:"App Name",id:"app-name",level:2},{value:"App Logo",id:"app-logo",level:2}];function d(e){const n={br:"br",h1:"h1",h2:"h2",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"-branding",children:"\ud83d\udd27 Branding"})}),"\n",(0,o.jsx)(n.h2,{id:"custom-subdomain",children:(0,o.jsx)(n.strong,{children:"Custom Subdomain"})}),"\n",(0,o.jsxs)(n.p,{children:["This page is accessible only to ",(0,o.jsx)(n.strong,{children:"Enterprise"})," users. Here, users can configure their own custom subdomain and access the OpenSign application directly through it."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"app-name",children:(0,o.jsx)(n.strong,{children:"App Name"})}),"\n",(0,o.jsxs)(n.p,{children:["Users can set a custom application name to reflect their brand identity.",(0,o.jsx)(n.br,{}),"\n","This name will appear in custom template page titles and other areas across the application, helping maintain consistent branding."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"app-logo",children:(0,o.jsx)(n.strong,{children:"App Logo"})}),"\n",(0,o.jsx)(n.p,{children:"Users can upload their own logo to display within the application instead of the default OpenSign logo, reinforcing their brand presence."})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}}}]); \ No newline at end of file diff --git a/assets/js/dc8c216b.848f2bc3.js b/assets/js/dc8c216b.848f2bc3.js new file mode 100644 index 000000000..f39eed598 --- /dev/null +++ b/assets/js/dc8c216b.848f2bc3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9144],{28453:(e,n,s)=>{s.d(n,{R:()=>i,x:()=>a});var t=s(96540);const o={},r=t.createContext(o);function i(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),t.createElement(r.Provider,{value:n},e.children)}},89073:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>p,frontMatter:()=>i,metadata:()=>t,toc:()=>c});const t=JSON.parse('{"id":"help/User Menu/Console/branding","title":"Branding","description":"Custom Subdomain","source":"@site/docs/help/User Menu/Console/branding.md","sourceDirName":"help/User Menu/Console","slug":"/help/User Menu/Console/branding","permalink":"/docs/help/User Menu/Console/branding","draft":false,"unlisted":false,"editUrl":"https://github.com/opensignlabs/opensign/tree/feat-docs/docs/docs/help/User Menu/Console/branding.md","tags":[],"version":"current","sidebarPosition":4,"frontMatter":{"sidebar_position":4,"title":"Branding"},"sidebar":"tutorialSidebar","previous":{"title":"General","permalink":"/docs/help/User Menu/Console/general"},"next":{"title":"Preferences","permalink":"/docs/help/User Menu/Console/globalSMTP"}}');var o=s(74848),r=s(28453);const i={sidebar_position:4,title:"Branding"},a="\ud83d\udd27 Branding",l={},c=[{value:"Custom Subdomain",id:"custom-subdomain",level:2},{value:"App Name",id:"app-name",level:2},{value:"App Logo",id:"app-logo",level:2}];function d(e){const n={br:"br",h1:"h1",h2:"h2",header:"header",hr:"hr",p:"p",strong:"strong",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.header,{children:(0,o.jsx)(n.h1,{id:"-branding",children:"\ud83d\udd27 Branding"})}),"\n",(0,o.jsx)(n.h2,{id:"custom-subdomain",children:(0,o.jsx)(n.strong,{children:"Custom Subdomain"})}),"\n",(0,o.jsxs)(n.p,{children:["This page is accessible only to ",(0,o.jsx)(n.strong,{children:"Enterprise"})," users. Here, users can configure their own custom subdomain and access the OpenSign application directly through it."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"app-name",children:(0,o.jsx)(n.strong,{children:"App Name"})}),"\n",(0,o.jsxs)(n.p,{children:["Users can set a custom application name to reflect their brand identity.",(0,o.jsx)(n.br,{}),"\n","This name will appear in custom template page titles and other areas across the application, helping maintain consistent branding."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"app-logo",children:(0,o.jsx)(n.strong,{children:"App Logo"})}),"\n",(0,o.jsx)(n.p,{children:"Users can upload their own logo to display within the application instead of the default OpenSign logo, reinforcing their brand presence."})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}}}]); \ No newline at end of file diff --git a/assets/js/main.2493ad18.js b/assets/js/main.c19202ed.js similarity index 53% rename from assets/js/main.2493ad18.js rename to assets/js/main.c19202ed.js index ec0444ad5..c9a2deb2a 100644 --- a/assets/js/main.2493ad18.js +++ b/assets/js/main.c19202ed.js @@ -1,2 +1,2 @@ -/*! For license information please see main.2493ad18.js.LICENSE.txt */ -(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8792],{204:(e,t,n)=>{"use strict";n.d(t,{G:()=>r});const r={page:{blogListPage:"blog-list-page",blogPostPage:"blog-post-page",blogTagsListPage:"blog-tags-list-page",blogTagPostListPage:"blog-tags-post-list-page",blogAuthorsListPage:"blog-authors-list-page",blogAuthorsPostsPage:"blog-authors-posts-page",docsDocPage:"docs-doc-page",docsTagsListPage:"docs-tags-list-page",docsTagDocListPage:"docs-tags-doc-list-page",mdxPage:"mdx-page"},wrapper:{main:"main-wrapper",blogPages:"blog-wrapper",docsPages:"docs-wrapper",mdxPages:"mdx-wrapper"},common:{editThisPage:"theme-edit-this-page",lastUpdated:"theme-last-updated",backToTopButton:"theme-back-to-top-button",codeBlock:"theme-code-block",admonition:"theme-admonition",unlistedBanner:"theme-unlisted-banner",draftBanner:"theme-draft-banner",admonitionType:e=>`theme-admonition-${e}`},layout:{},docs:{docVersionBanner:"theme-doc-version-banner",docVersionBadge:"theme-doc-version-badge",docBreadcrumbs:"theme-doc-breadcrumbs",docMarkdown:"theme-doc-markdown",docTocMobile:"theme-doc-toc-mobile",docTocDesktop:"theme-doc-toc-desktop",docFooter:"theme-doc-footer",docFooterTagsRow:"theme-doc-footer-tags-row",docFooterEditMetaRow:"theme-doc-footer-edit-meta-row",docSidebarContainer:"theme-doc-sidebar-container",docSidebarMenu:"theme-doc-sidebar-menu",docSidebarItemCategory:"theme-doc-sidebar-item-category",docSidebarItemLink:"theme-doc-sidebar-item-link",docSidebarItemCategoryLevel:e=>`theme-doc-sidebar-item-category-level-${e}`,docSidebarItemLinkLevel:e=>`theme-doc-sidebar-item-link-level-${e}`},blog:{blogFooterTagsRow:"theme-blog-footer-tags-row",blogFooterEditMetaRow:"theme-blog-footer-edit-meta-row"},pages:{pageFooterEditMetaRow:"theme-pages-footer-edit-meta-row"}}},1093:e=>{"use strict";var t=Object.prototype.toString;e.exports=function(e){var n=t.call(e),r="[object Arguments]"===n;return r||(r="[object Array]"!==n&&null!==e&&"object"==typeof e&&"number"==typeof e.length&&e.length>=0&&"[object Function]"===t.call(e.callee)),r}},1189:(e,t,n)=>{"use strict";var r=Array.prototype.slice,o=n(1093),a=Object.keys,i=a?function(e){return a(e)}:n(28875),s=Object.keys;i.shim=function(){if(Object.keys){var e=function(){var e=Object.keys(arguments);return e&&e.length===arguments.length}(1,2);e||(Object.keys=function(e){return o(e)?s(r.call(e)):s(e)})}else Object.keys=i;return Object.keys||i},e.exports=i},2694:(e,t,n)=>{"use strict";var r=n(6925);function o(){}function a(){}a.resetWarningCache=o,e.exports=function(){function e(e,t,n,o,a,i){if(i!==r){var s=new Error("Calling PropTypes validators directly is not supported by the `prop-types` package. Use PropTypes.checkPropTypes() to call them. Read more at http://fb.me/use-check-prop-types");throw s.name="Invariant Violation",s}}function t(){return e}e.isRequired=e;var n={array:e,bigint:e,bool:e,func:e,number:e,object:e,string:e,symbol:e,any:e,arrayOf:t,element:e,elementType:e,instanceOf:t,node:e,objectOf:t,oneOf:t,oneOfType:t,shape:t,exact:t,checkPropTypes:a,resetWarningCache:o};return n.PropTypes=n,n}},2833:e=>{e.exports=function(e,t,n,r){var o=n?n.call(r,e,t):void 0;if(void 0!==o)return!!o;if(e===t)return!0;if("object"!=typeof e||!e||"object"!=typeof t||!t)return!1;var a=Object.keys(e),i=Object.keys(t);if(a.length!==i.length)return!1;for(var s=Object.prototype.hasOwnProperty.bind(t),l=0;l{"use strict";n.r(t)},3918:(e,t,n)=>{"use strict";var r=n(65606);function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;te.length)&&(n=e.length),e.substring(n-t.length,n)===t}var w="",S="",x="",k="",A={deepStrictEqual:"Expected values to be strictly deep-equal:",strictEqual:"Expected values to be strictly equal:",strictEqualObject:'Expected "actual" to be reference-equal to "expected":',deepEqual:"Expected values to be loosely deep-equal:",equal:"Expected values to be loosely equal:",notDeepStrictEqual:'Expected "actual" not to be strictly deep-equal to:',notStrictEqual:'Expected "actual" to be strictly unequal to:',notStrictEqualObject:'Expected "actual" not to be reference-equal to "expected":',notDeepEqual:'Expected "actual" not to be loosely deep-equal to:',notEqual:'Expected "actual" to be loosely unequal to:',notIdentical:"Values identical but not reference-equal:"};function _(e){var t=Object.keys(e),n=Object.create(Object.getPrototypeOf(e));return t.forEach((function(t){n[t]=e[t]})),Object.defineProperty(n,"message",{value:e.message}),n}function P(e){return b(e,{compact:!1,customInspect:!1,depth:1e3,maxArrayLength:1/0,showHidden:!1,breakLength:1/0,showProxy:!1,sorted:!0,getters:!0})}function E(e,t,n){var o="",a="",i=0,s="",l=!1,c=P(e),u=c.split("\n"),d=P(t).split("\n"),p=0,f="";if("strictEqual"===n&&"object"===g(e)&&"object"===g(t)&&null!==e&&null!==t&&(n="strictEqualObject"),1===u.length&&1===d.length&&u[0]!==d[0]){var m=u[0].length+d[0].length;if(m<=10){if(!("object"===g(e)&&null!==e||"object"===g(t)&&null!==t||0===e&&0===t))return"".concat(A[n],"\n\n")+"".concat(u[0]," !== ").concat(d[0],"\n")}else if("strictEqualObject"!==n){if(m<(r.stderr&&r.stderr.isTTY?r.stderr.columns:80)){for(;u[0][p]===d[0][p];)p++;p>2&&(f="\n ".concat(function(e,t){if(t=Math.floor(t),0==e.length||0==t)return"";var n=e.length*t;for(t=Math.floor(Math.log(t)/Math.log(2));t;)e+=e,t--;return e+e.substring(0,n-e.length)}(" ",p),"^"),p=0)}}}for(var h=u[u.length-1],b=d[d.length-1];h===b&&(p++<2?s="\n ".concat(h).concat(s):o=h,u.pop(),d.pop(),0!==u.length&&0!==d.length);)h=u[u.length-1],b=d[d.length-1];var y=Math.max(u.length,d.length);if(0===y){var _=c.split("\n");if(_.length>30)for(_[26]="".concat(w,"...").concat(k);_.length>27;)_.pop();return"".concat(A.notIdentical,"\n\n").concat(_.join("\n"),"\n")}p>3&&(s="\n".concat(w,"...").concat(k).concat(s),l=!0),""!==o&&(s="\n ".concat(o).concat(s),o="");var E=0,I=A[n]+"\n".concat(S,"+ actual").concat(k," ").concat(x,"- expected").concat(k),j=" ".concat(w,"...").concat(k," Lines skipped");for(p=0;p1&&p>2&&(C>4?(a+="\n".concat(w,"...").concat(k),l=!0):C>3&&(a+="\n ".concat(d[p-2]),E++),a+="\n ".concat(d[p-1]),E++),i=p,o+="\n".concat(x,"-").concat(k," ").concat(d[p]),E++;else if(d.length1&&p>2&&(C>4?(a+="\n".concat(w,"...").concat(k),l=!0):C>3&&(a+="\n ".concat(u[p-2]),E++),a+="\n ".concat(u[p-1]),E++),i=p,a+="\n".concat(S,"+").concat(k," ").concat(u[p]),E++;else{var O=d[p],T=u[p],R=T!==O&&(!v(T,",")||T.slice(0,-1)!==O);R&&v(O,",")&&O.slice(0,-1)===T&&(R=!1,T+=","),R?(C>1&&p>2&&(C>4?(a+="\n".concat(w,"...").concat(k),l=!0):C>3&&(a+="\n ".concat(u[p-2]),E++),a+="\n ".concat(u[p-1]),E++),i=p,a+="\n".concat(S,"+").concat(k," ").concat(T),o+="\n".concat(x,"-").concat(k," ").concat(O),E+=2):(a+=o,o="",1!==C&&0!==p||(a+="\n ".concat(T),E++))}if(E>20&&p30)for(f[26]="".concat(w,"...").concat(k);f.length>27;)f.pop();t=1===f.length?p.call(this,"".concat(d," ").concat(f[0])):p.call(this,"".concat(d,"\n\n").concat(f.join("\n"),"\n"))}else{var m=P(i),h="",b=A[o];"notDeepEqual"===o||"notEqual"===o?(m="".concat(A[o],"\n\n").concat(m)).length>1024&&(m="".concat(m.slice(0,1021),"...")):(h="".concat(P(s)),m.length>512&&(m="".concat(m.slice(0,509),"...")),h.length>512&&(h="".concat(h.slice(0,509),"...")),"deepEqual"===o||"equal"===o?m="".concat(b,"\n\n").concat(m,"\n\nshould equal\n\n"):h=" ".concat(o," ").concat(h)),t=p.call(this,"".concat(m).concat(h))}return Error.stackTraceLimit=l,t.generatedMessage=!n,Object.defineProperty(u(t),"name",{value:"AssertionError [ERR_ASSERTION]",enumerable:!1,writable:!0,configurable:!0}),t.code="ERR_ASSERTION",t.actual=i,t.expected=s,t.operator=o,Error.captureStackTrace&&Error.captureStackTrace(u(t),a),t.stack,t.name="AssertionError",c(t)}return i=v,(l=[{key:"toString",value:function(){return"".concat(this.name," [").concat(this.code,"]: ").concat(this.message)}},{key:t,value:function(e,t){return b(this,a(a({},t),{},{customInspect:!1,depth:0}))}}])&&s(i.prototype,l),d&&s(i,d),Object.defineProperty(i,"prototype",{writable:!1}),v}(d(Error),b.custom);e.exports=I},4023:(e,t,n)=>{"use strict";n.d(t,{A:()=>h});var r=n(96540),o=n(61934),a=n(27143),i=n(30099),s=n(36668),l=n(75313),c=n(74848);function u(e){let{error:t,tryAgain:n}=e;return(0,c.jsxs)("div",{style:{display:"flex",flexDirection:"column",justifyContent:"center",alignItems:"flex-start",minHeight:"100vh",width:"100%",maxWidth:"80ch",fontSize:"20px",margin:"0 auto",padding:"1rem"},children:[(0,c.jsx)("h1",{style:{fontSize:"3rem"},children:"This page crashed"}),(0,c.jsx)("button",{type:"button",onClick:n,style:{margin:"1rem 0",fontSize:"2rem",cursor:"pointer",borderRadius:20,padding:"1rem"},children:"Try again"}),(0,c.jsx)(d,{error:t})]})}function d(e){let{error:t}=e;const n=(0,i.rA)(t).map((e=>e.message)).join("\n\nCause:\n");return(0,c.jsx)("p",{style:{whiteSpace:"pre-wrap"},children:n})}function p(e){let{children:t}=e;return(0,c.jsx)(l.W,{value:{plugin:{name:"docusaurus-core-error-boundary",id:"default"}},children:t})}function f(e){let{error:t,tryAgain:n}=e;return(0,c.jsx)(p,{children:(0,c.jsxs)(h,{fallback:()=>(0,c.jsx)(u,{error:t,tryAgain:n}),children:[(0,c.jsx)(a.A,{children:(0,c.jsx)("title",{children:"Page Error"})}),(0,c.jsx)(s.A,{children:(0,c.jsx)(u,{error:t,tryAgain:n})})]})})}const m=e=>(0,c.jsx)(f,{...e});class h extends r.Component{constructor(e){super(e),this.state={error:null}}componentDidCatch(e){o.default.canUseDOM&&this.setState({error:e})}render(){const{children:e}=this.props,{error:t}=this.state;if(t){const e={error:t,tryAgain:()=>this.setState({error:null})};return(this.props.fallback??m)(e)}return e??null}}},4146:(e,t,n)=>{"use strict";var r=n(44363),o={childContextTypes:!0,contextType:!0,contextTypes:!0,defaultProps:!0,displayName:!0,getDefaultProps:!0,getDerivedStateFromError:!0,getDerivedStateFromProps:!0,mixins:!0,propTypes:!0,type:!0},a={name:!0,length:!0,prototype:!0,caller:!0,callee:!0,arguments:!0,arity:!0},i={$$typeof:!0,compare:!0,defaultProps:!0,displayName:!0,propTypes:!0,type:!0},s={};function l(e){return r.isMemo(e)?i:s[e.$$typeof]||o}s[r.ForwardRef]={$$typeof:!0,render:!0,defaultProps:!0,displayName:!0,propTypes:!0},s[r.Memo]=i;var c=Object.defineProperty,u=Object.getOwnPropertyNames,d=Object.getOwnPropertySymbols,p=Object.getOwnPropertyDescriptor,f=Object.getPrototypeOf,m=Object.prototype;e.exports=function e(t,n,r){if("string"!=typeof n){if(m){var o=f(n);o&&o!==m&&e(t,o,r)}var i=u(n);d&&(i=i.concat(d(n)));for(var s=l(t),h=l(n),g=0;g{"use strict";n.r(t),n.d(t,{default:()=>r});const r={title:"OpenSign\u2122",tagline:"Official OpenSign\u2122 Docs - tutorials, API documentation, self-host help & much more.",favicon:"img/favicon.ico",url:"https://docs.opensignlabs.com",baseUrl:"/",organizationName:"opensignlabs",projectName:"opensign",onBrokenLinks:"throw",onBrokenMarkdownLinks:"warn",i18n:{defaultLocale:"en",locales:["en"],path:"i18n",localeConfigs:{}},presets:[["classic",{docs:{sidebarPath:"./sidebars.js",editUrl:"https://github.com/opensignlabs/opensign/tree/feat-docs/docs/",docItemComponent:"@theme/ApiItem"},blog:{showReadingTime:!0,editUrl:"https://github.com/facebook/docusaurus/tree/feat-docs/docs/"},theme:{customCss:"./src/css/custom.css"}}]],plugins:[["docusaurus-plugin-openapi-docs",{id:"openapi",docsPluginId:"default",config:{opensign_v1:{specPath:"docs/API-docs/v1/opensign.yaml",outputDir:"docs/API-docs/v1",sidebarOptions:{groupPathsBy:"tag"}},opensign_v1_1:{specPath:"docs/API-docs/v1.1/opensign.yaml",outputDir:"docs/API-docs/v1.1",sidebarOptions:{groupPathsBy:"tag"}}}}]],themes:["docusaurus-theme-openapi-docs"],themeConfig:{announcementBar:{id:"support_us",content:'Help use spread the word - \u2b50 OpenSign on GitHub',backgroundColor:"#cae4fa",textColor:"#091E42",isCloseable:!1},image:"img/docusaurus-social-card.png",navbar:{title:"OpenSign\u2122",logo:{alt:"OpenSign\u2122 Logo",src:"img/logo.png"},items:[{type:"docSidebar",sidebarId:"tutorialSidebar",position:"left",label:"Help"},{type:"docSidebar",sidebarId:"apiSidebar",position:"left",label:"APIs"},{type:"docSidebar",sidebarId:"contributeSidebar",position:"left",label:"Contribute"},{href:"https://www.opensignlabs.com/plans-pricing",label:"Cloud Pricing",position:"left"},{type:"docSidebar",sidebarId:"selfhostSidebar",position:"left",label:"Self-host"},{href:"https://github.com/opensignlabs/opensign",label:"GitHub",position:"right"}],hideOnScroll:!1},footer:{style:"dark",links:[{title:"Docs",items:[{label:"Help",to:"/docs/help/intro"},{label:"APIs",to:"/docs/API-docs/v1.1"},{label:"Contribute",to:"/docs/contribute/intro"},{label:"Self-host",to:"/docs/self-host/intro"}]},{title:"Community",items:[{label:"Discord",href:"https://discord.com/invite/xe9TDuyAyj"},{label:"LinkedIn",href:"https://www.linkedin.com/company/opensign%E2%84%A2/"},{label:"Twitter",href:"https://www.twitter.com/opensignhq"},{label:"Facebook",href:"https://www.facebook.com/profile.php?id=61551030403669"}]},{title:"More",items:[{label:"Official Website",href:"https://www.opensignlabs.com"},{label:"GitHub",href:"https://github.com/opensignlabs/opensign"}]}],copyright:"Copyright \xa9 2025 OpenSign\u2122.
The best Open Source DocuSign alternative."},prism:{theme:{plain:{color:"#393A34",backgroundColor:"#f6f8fa"},styles:[{types:["comment","prolog","doctype","cdata"],style:{color:"#999988",fontStyle:"italic"}},{types:["namespace"],style:{opacity:.7}},{types:["string","attr-value"],style:{color:"#e3116c"}},{types:["punctuation","operator"],style:{color:"#393A34"}},{types:["entity","url","symbol","number","boolean","variable","constant","property","regex","inserted"],style:{color:"#36acaa"}},{types:["atrule","keyword","attr-name","selector"],style:{color:"#00a4db"}},{types:["function","deleted","tag"],style:{color:"#d73a49"}},{types:["function-variable"],style:{color:"#6f42c1"}},{types:["tag","selector","keyword"],style:{color:"#00009f"}}]},darkTheme:{plain:{color:"#F8F8F2",backgroundColor:"#282A36"},styles:[{types:["prolog","constant","builtin"],style:{color:"rgb(189, 147, 249)"}},{types:["inserted","function"],style:{color:"rgb(80, 250, 123)"}},{types:["deleted"],style:{color:"rgb(255, 85, 85)"}},{types:["changed"],style:{color:"rgb(255, 184, 108)"}},{types:["punctuation","symbol"],style:{color:"rgb(248, 248, 242)"}},{types:["string","char","tag","selector"],style:{color:"rgb(255, 121, 198)"}},{types:["keyword","variable"],style:{color:"rgb(189, 147, 249)",fontStyle:"italic"}},{types:["comment"],style:{color:"rgb(98, 114, 164)"}},{types:["attr-name"],style:{color:"rgb(241, 250, 140)"}}]},additionalLanguages:[],magicComments:[{className:"theme-code-block-highlighted-line",line:"highlight-next-line",block:{start:"highlight-start",end:"highlight-end"}}]},colorMode:{defaultMode:"light",disableSwitch:!1,respectPrefersColorScheme:!1},docs:{versionPersistence:"localStorage",sidebar:{hideable:!1,autoCollapseCategories:!1}},blog:{sidebar:{groupByYear:!0}},metadata:[],tableOfContents:{minHeadingLevel:2,maxHeadingLevel:3}},baseUrlIssueBanner:!0,future:{experimental_faster:{swcJsLoader:!1,swcJsMinimizer:!1,swcHtmlMinimizer:!1,lightningCssMinimizer:!1,mdxCrossCompilerCache:!1,rspackBundler:!1},experimental_storage:{type:"localStorage",namespace:!1},experimental_router:"browser"},onBrokenAnchors:"warn",onDuplicateRoutes:"warn",staticDirectories:["static"],customFields:{},scripts:[],headTags:[],stylesheets:[],clientModules:[],titleDelimiter:"|",noIndex:!1,markdown:{format:"mdx",mermaid:!1,mdx1Compat:{comments:!0,admonitions:!0,headingIds:!0},anchors:{maintainCase:!1}}}},5338:(e,t,n)=>{"use strict";var r=n(40961);t.createRoot=r.createRoot,t.hydrateRoot=r.hydrateRoot},5528:(e,t,n)=>{"use strict";n.d(t,{M:()=>f,e:()=>p});var r=n(96540),o=n(63065),a=n(86682),i=n(30604),s=n(53115),l=n(26849),c=n(74848);const u=r.createContext(void 0);function d(){const e=function(){const e=(0,o.YL)(),{items:t}=(0,s.p)().navbar;return 0===t.length&&!e.component}(),t=(0,a.l)(),n=!e&&"mobile"===t,[l,c]=(0,r.useState)(!1);(0,i.$Z)((()=>{if(l)return c(!1),!1}));const u=(0,r.useCallback)((()=>{c((e=>!e))}),[]);return(0,r.useEffect)((()=>{"desktop"===t&&c(!1)}),[t]),(0,r.useMemo)((()=>({disabled:e,shouldRender:n,toggle:u,shown:l})),[e,n,u,l])}function p(e){let{children:t}=e;const n=d();return(0,c.jsx)(u.Provider,{value:n,children:t})}function f(){const e=r.useContext(u);if(void 0===e)throw new l.dV("NavbarMobileSidebarProvider");return e}},5556:(e,t,n)=>{e.exports=n(2694)()},5947:function(e,t,n){var r,o;r=function(){var e,t,n={version:"0.2.0"},r=n.settings={minimum:.08,easing:"ease",positionUsing:"",speed:200,trickle:!0,trickleRate:.02,trickleSpeed:800,showSpinner:!0,barSelector:'[role="bar"]',spinnerSelector:'[role="spinner"]',parent:"body",template:'
'};function o(e,t,n){return en?n:e}function a(e){return 100*(-1+e)}function i(e,t,n){var o;return(o="translate3d"===r.positionUsing?{transform:"translate3d("+a(e)+"%,0,0)"}:"translate"===r.positionUsing?{transform:"translate("+a(e)+"%,0)"}:{"margin-left":a(e)+"%"}).transition="all "+t+"ms "+n,o}n.configure=function(e){var t,n;for(t in e)void 0!==(n=e[t])&&e.hasOwnProperty(t)&&(r[t]=n);return this},n.status=null,n.set=function(e){var t=n.isStarted();e=o(e,r.minimum,1),n.status=1===e?null:e;var a=n.render(!t),c=a.querySelector(r.barSelector),u=r.speed,d=r.easing;return a.offsetWidth,s((function(t){""===r.positionUsing&&(r.positionUsing=n.getPositioningCSS()),l(c,i(e,u,d)),1===e?(l(a,{transition:"none",opacity:1}),a.offsetWidth,setTimeout((function(){l(a,{transition:"all "+u+"ms linear",opacity:0}),setTimeout((function(){n.remove(),t()}),u)}),u)):setTimeout(t,u)})),this},n.isStarted=function(){return"number"==typeof n.status},n.start=function(){n.status||n.set(0);var e=function(){setTimeout((function(){n.status&&(n.trickle(),e())}),r.trickleSpeed)};return r.trickle&&e(),this},n.done=function(e){return e||n.status?n.inc(.3+.5*Math.random()).set(1):this},n.inc=function(e){var t=n.status;return t?("number"!=typeof e&&(e=(1-t)*o(Math.random()*t,.1,.95)),t=o(t+e,0,.994),n.set(t)):n.start()},n.trickle=function(){return n.inc(Math.random()*r.trickleRate)},e=0,t=0,n.promise=function(r){return r&&"resolved"!==r.state()?(0===t&&n.start(),e++,t++,r.always((function(){0==--t?(e=0,n.done()):n.set((e-t)/e)})),this):this},n.render=function(e){if(n.isRendered())return document.getElementById("nprogress");u(document.documentElement,"nprogress-busy");var t=document.createElement("div");t.id="nprogress",t.innerHTML=r.template;var o,i=t.querySelector(r.barSelector),s=e?"-100":a(n.status||0),c=document.querySelector(r.parent);return l(i,{transition:"all 0 linear",transform:"translate3d("+s+"%,0,0)"}),r.showSpinner||(o=t.querySelector(r.spinnerSelector))&&f(o),c!=document.body&&u(c,"nprogress-custom-parent"),c.appendChild(t),t},n.remove=function(){d(document.documentElement,"nprogress-busy"),d(document.querySelector(r.parent),"nprogress-custom-parent");var e=document.getElementById("nprogress");e&&f(e)},n.isRendered=function(){return!!document.getElementById("nprogress")},n.getPositioningCSS=function(){var e=document.body.style,t="WebkitTransform"in e?"Webkit":"MozTransform"in e?"Moz":"msTransform"in e?"ms":"OTransform"in e?"O":"";return t+"Perspective"in e?"translate3d":t+"Transform"in e?"translate":"margin"};var s=function(){var e=[];function t(){var n=e.shift();n&&n(t)}return function(n){e.push(n),1==e.length&&t()}}(),l=function(){var e=["Webkit","O","Moz","ms"],t={};function n(e){return e.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,(function(e,t){return t.toUpperCase()}))}function r(t){var n=document.body.style;if(t in n)return t;for(var r,o=e.length,a=t.charAt(0).toUpperCase()+t.slice(1);o--;)if((r=e[o]+a)in n)return r;return t}function o(e){return e=n(e),t[e]||(t[e]=r(e))}function a(e,t,n){t=o(t),e.style[t]=n}return function(e,t){var n,r,o=arguments;if(2==o.length)for(n in t)void 0!==(r=t[n])&&t.hasOwnProperty(n)&&a(e,n,r);else a(e,o[1],o[2])}}();function c(e,t){return("string"==typeof e?e:p(e)).indexOf(" "+t+" ")>=0}function u(e,t){var n=p(e),r=n+t;c(n,t)||(e.className=r.substring(1))}function d(e,t){var n,r=p(e);c(e,t)&&(n=r.replace(" "+t+" "," "),e.className=n.substring(1,n.length-1))}function p(e){return(" "+(e.className||"")+" ").replace(/\s+/gi," ")}function f(e){e&&e.parentNode&&e.parentNode.removeChild(e)}return n},void 0===(o="function"==typeof r?r.call(t,n,t,e):r)||(e.exports=o)},6188:e=>{"use strict";e.exports=Math.max},6549:e=>{"use strict";e.exports=Object.getOwnPropertyDescriptor},6925:e=>{"use strict";e.exports="SECRET_DO_NOT_PASS_THIS_OR_YOU_WILL_BE_FIRED"},6969:e=>{e.exports&&(e.exports={core:{meta:{path:"components/prism-core.js",option:"mandatory"},core:"Core"},themes:{meta:{path:"themes/{id}.css",link:"index.html?theme={id}",exclusive:!0},prism:{title:"Default",option:"default"},"prism-dark":"Dark","prism-funky":"Funky","prism-okaidia":{title:"Okaidia",owner:"ocodia"},"prism-twilight":{title:"Twilight",owner:"remybach"},"prism-coy":{title:"Coy",owner:"tshedor"},"prism-solarizedlight":{title:"Solarized Light",owner:"hectormatos2011 "},"prism-tomorrow":{title:"Tomorrow Night",owner:"Rosey"}},languages:{meta:{path:"components/prism-{id}",noCSS:!0,examplesPath:"examples/prism-{id}",addCheckAll:!0},markup:{title:"Markup",alias:["html","xml","svg","mathml","ssml","atom","rss"],aliasTitles:{html:"HTML",xml:"XML",svg:"SVG",mathml:"MathML",ssml:"SSML",atom:"Atom",rss:"RSS"},option:"default"},css:{title:"CSS",option:"default",modify:"markup"},clike:{title:"C-like",option:"default"},javascript:{title:"JavaScript",require:"clike",modify:"markup",optional:"regex",alias:"js",option:"default"},abap:{title:"ABAP",owner:"dellagustin"},abnf:{title:"ABNF",owner:"RunDevelopment"},actionscript:{title:"ActionScript",require:"javascript",modify:"markup",owner:"Golmote"},ada:{title:"Ada",owner:"Lucretia"},agda:{title:"Agda",owner:"xy-ren"},al:{title:"AL",owner:"RunDevelopment"},antlr4:{title:"ANTLR4",alias:"g4",owner:"RunDevelopment"},apacheconf:{title:"Apache Configuration",owner:"GuiTeK"},apex:{title:"Apex",require:["clike","sql"],owner:"RunDevelopment"},apl:{title:"APL",owner:"ngn"},applescript:{title:"AppleScript",owner:"Golmote"},aql:{title:"AQL",owner:"RunDevelopment"},arduino:{title:"Arduino",require:"cpp",alias:"ino",owner:"dkern"},arff:{title:"ARFF",owner:"Golmote"},armasm:{title:"ARM Assembly",alias:"arm-asm",owner:"RunDevelopment"},arturo:{title:"Arturo",alias:"art",optional:["bash","css","javascript","markup","markdown","sql"],owner:"drkameleon"},asciidoc:{alias:"adoc",title:"AsciiDoc",owner:"Golmote"},aspnet:{title:"ASP.NET (C#)",require:["markup","csharp"],owner:"nauzilus"},asm6502:{title:"6502 Assembly",owner:"kzurawel"},asmatmel:{title:"Atmel AVR Assembly",owner:"cerkit"},autohotkey:{title:"AutoHotkey",owner:"aviaryan"},autoit:{title:"AutoIt",owner:"Golmote"},avisynth:{title:"AviSynth",alias:"avs",owner:"Zinfidel"},"avro-idl":{title:"Avro IDL",alias:"avdl",owner:"RunDevelopment"},awk:{title:"AWK",alias:"gawk",aliasTitles:{gawk:"GAWK"},owner:"RunDevelopment"},bash:{title:"Bash",alias:["sh","shell"],aliasTitles:{sh:"Shell",shell:"Shell"},owner:"zeitgeist87"},basic:{title:"BASIC",owner:"Golmote"},batch:{title:"Batch",owner:"Golmote"},bbcode:{title:"BBcode",alias:"shortcode",aliasTitles:{shortcode:"Shortcode"},owner:"RunDevelopment"},bbj:{title:"BBj",owner:"hyyan"},bicep:{title:"Bicep",owner:"johnnyreilly"},birb:{title:"Birb",require:"clike",owner:"Calamity210"},bison:{title:"Bison",require:"c",owner:"Golmote"},bnf:{title:"BNF",alias:"rbnf",aliasTitles:{rbnf:"RBNF"},owner:"RunDevelopment"},bqn:{title:"BQN",owner:"yewscion"},brainfuck:{title:"Brainfuck",owner:"Golmote"},brightscript:{title:"BrightScript",owner:"RunDevelopment"},bro:{title:"Bro",owner:"wayward710"},bsl:{title:"BSL (1C:Enterprise)",alias:"oscript",aliasTitles:{oscript:"OneScript"},owner:"Diversus23"},c:{title:"C",require:"clike",owner:"zeitgeist87"},csharp:{title:"C#",require:"clike",alias:["cs","dotnet"],owner:"mvalipour"},cpp:{title:"C++",require:"c",owner:"zeitgeist87"},cfscript:{title:"CFScript",require:"clike",alias:"cfc",owner:"mjclemente"},chaiscript:{title:"ChaiScript",require:["clike","cpp"],owner:"RunDevelopment"},cil:{title:"CIL",owner:"sbrl"},cilkc:{title:"Cilk/C",require:"c",alias:"cilk-c",owner:"OpenCilk"},cilkcpp:{title:"Cilk/C++",require:"cpp",alias:["cilk-cpp","cilk"],owner:"OpenCilk"},clojure:{title:"Clojure",owner:"troglotit"},cmake:{title:"CMake",owner:"mjrogozinski"},cobol:{title:"COBOL",owner:"RunDevelopment"},coffeescript:{title:"CoffeeScript",require:"javascript",alias:"coffee",owner:"R-osey"},concurnas:{title:"Concurnas",alias:"conc",owner:"jasontatton"},csp:{title:"Content-Security-Policy",owner:"ScottHelme"},cooklang:{title:"Cooklang",owner:"ahue"},coq:{title:"Coq",owner:"RunDevelopment"},crystal:{title:"Crystal",require:"ruby",owner:"MakeNowJust"},"css-extras":{title:"CSS Extras",require:"css",modify:"css",owner:"milesj"},csv:{title:"CSV",owner:"RunDevelopment"},cue:{title:"CUE",owner:"RunDevelopment"},cypher:{title:"Cypher",owner:"RunDevelopment"},d:{title:"D",require:"clike",owner:"Golmote"},dart:{title:"Dart",require:"clike",owner:"Golmote"},dataweave:{title:"DataWeave",owner:"machaval"},dax:{title:"DAX",owner:"peterbud"},dhall:{title:"Dhall",owner:"RunDevelopment"},diff:{title:"Diff",owner:"uranusjr"},django:{title:"Django/Jinja2",require:"markup-templating",alias:"jinja2",owner:"romanvm"},"dns-zone-file":{title:"DNS zone file",owner:"RunDevelopment",alias:"dns-zone"},docker:{title:"Docker",alias:"dockerfile",owner:"JustinBeckwith"},dot:{title:"DOT (Graphviz)",alias:"gv",optional:"markup",owner:"RunDevelopment"},ebnf:{title:"EBNF",owner:"RunDevelopment"},editorconfig:{title:"EditorConfig",owner:"osipxd"},eiffel:{title:"Eiffel",owner:"Conaclos"},ejs:{title:"EJS",require:["javascript","markup-templating"],owner:"RunDevelopment",alias:"eta",aliasTitles:{eta:"Eta"}},elixir:{title:"Elixir",owner:"Golmote"},elm:{title:"Elm",owner:"zwilias"},etlua:{title:"Embedded Lua templating",require:["lua","markup-templating"],owner:"RunDevelopment"},erb:{title:"ERB",require:["ruby","markup-templating"],owner:"Golmote"},erlang:{title:"Erlang",owner:"Golmote"},"excel-formula":{title:"Excel Formula",alias:["xlsx","xls"],owner:"RunDevelopment"},fsharp:{title:"F#",require:"clike",owner:"simonreynolds7"},factor:{title:"Factor",owner:"catb0t"},false:{title:"False",owner:"edukisto"},"firestore-security-rules":{title:"Firestore security rules",require:"clike",owner:"RunDevelopment"},flow:{title:"Flow",require:"javascript",owner:"Golmote"},fortran:{title:"Fortran",owner:"Golmote"},ftl:{title:"FreeMarker Template Language",require:"markup-templating",owner:"RunDevelopment"},gml:{title:"GameMaker Language",alias:"gamemakerlanguage",require:"clike",owner:"LiarOnce"},gap:{title:"GAP (CAS)",owner:"RunDevelopment"},gcode:{title:"G-code",owner:"RunDevelopment"},gdscript:{title:"GDScript",owner:"RunDevelopment"},gedcom:{title:"GEDCOM",owner:"Golmote"},gettext:{title:"gettext",alias:"po",owner:"RunDevelopment"},gherkin:{title:"Gherkin",owner:"hason"},git:{title:"Git",owner:"lgiraudel"},glsl:{title:"GLSL",require:"c",owner:"Golmote"},gn:{title:"GN",alias:"gni",owner:"RunDevelopment"},"linker-script":{title:"GNU Linker Script",alias:"ld",owner:"RunDevelopment"},go:{title:"Go",require:"clike",owner:"arnehormann"},"go-module":{title:"Go module",alias:"go-mod",owner:"RunDevelopment"},gradle:{title:"Gradle",require:"clike",owner:"zeabdelkhalek-badido18"},graphql:{title:"GraphQL",optional:"markdown",owner:"Golmote"},groovy:{title:"Groovy",require:"clike",owner:"robfletcher"},haml:{title:"Haml",require:"ruby",optional:["css","css-extras","coffeescript","erb","javascript","less","markdown","scss","textile"],owner:"Golmote"},handlebars:{title:"Handlebars",require:"markup-templating",alias:["hbs","mustache"],aliasTitles:{mustache:"Mustache"},owner:"Golmote"},haskell:{title:"Haskell",alias:"hs",owner:"bholst"},haxe:{title:"Haxe",require:"clike",optional:"regex",owner:"Golmote"},hcl:{title:"HCL",owner:"outsideris"},hlsl:{title:"HLSL",require:"c",owner:"RunDevelopment"},hoon:{title:"Hoon",owner:"matildepark"},http:{title:"HTTP",optional:["csp","css","hpkp","hsts","javascript","json","markup","uri"],owner:"danielgtaylor"},hpkp:{title:"HTTP Public-Key-Pins",owner:"ScottHelme"},hsts:{title:"HTTP Strict-Transport-Security",owner:"ScottHelme"},ichigojam:{title:"IchigoJam",owner:"BlueCocoa"},icon:{title:"Icon",owner:"Golmote"},"icu-message-format":{title:"ICU Message Format",owner:"RunDevelopment"},idris:{title:"Idris",alias:"idr",owner:"KeenS",require:"haskell"},ignore:{title:".ignore",owner:"osipxd",alias:["gitignore","hgignore","npmignore"],aliasTitles:{gitignore:".gitignore",hgignore:".hgignore",npmignore:".npmignore"}},inform7:{title:"Inform 7",owner:"Golmote"},ini:{title:"Ini",owner:"aviaryan"},io:{title:"Io",owner:"AlesTsurko"},j:{title:"J",owner:"Golmote"},java:{title:"Java",require:"clike",owner:"sherblot"},javadoc:{title:"JavaDoc",require:["markup","java","javadoclike"],modify:"java",optional:"scala",owner:"RunDevelopment"},javadoclike:{title:"JavaDoc-like",modify:["java","javascript","php"],owner:"RunDevelopment"},javastacktrace:{title:"Java stack trace",owner:"RunDevelopment"},jexl:{title:"Jexl",owner:"czosel"},jolie:{title:"Jolie",require:"clike",owner:"thesave"},jq:{title:"JQ",owner:"RunDevelopment"},jsdoc:{title:"JSDoc",require:["javascript","javadoclike","typescript"],modify:"javascript",optional:["actionscript","coffeescript"],owner:"RunDevelopment"},"js-extras":{title:"JS Extras",require:"javascript",modify:"javascript",optional:["actionscript","coffeescript","flow","n4js","typescript"],owner:"RunDevelopment"},json:{title:"JSON",alias:"webmanifest",aliasTitles:{webmanifest:"Web App Manifest"},owner:"CupOfTea696"},json5:{title:"JSON5",require:"json",owner:"RunDevelopment"},jsonp:{title:"JSONP",require:"json",owner:"RunDevelopment"},jsstacktrace:{title:"JS stack trace",owner:"sbrl"},"js-templates":{title:"JS Templates",require:"javascript",modify:"javascript",optional:["css","css-extras","graphql","markdown","markup","sql"],owner:"RunDevelopment"},julia:{title:"Julia",owner:"cdagnino"},keepalived:{title:"Keepalived Configure",owner:"dev-itsheng"},keyman:{title:"Keyman",owner:"mcdurdin"},kotlin:{title:"Kotlin",alias:["kt","kts"],aliasTitles:{kts:"Kotlin Script"},require:"clike",owner:"Golmote"},kumir:{title:"KuMir (\u041a\u0443\u041c\u0438\u0440)",alias:"kum",owner:"edukisto"},kusto:{title:"Kusto",owner:"RunDevelopment"},latex:{title:"LaTeX",alias:["tex","context"],aliasTitles:{tex:"TeX",context:"ConTeXt"},owner:"japborst"},latte:{title:"Latte",require:["clike","markup-templating","php"],owner:"nette"},less:{title:"Less",require:"css",optional:"css-extras",owner:"Golmote"},lilypond:{title:"LilyPond",require:"scheme",alias:"ly",owner:"RunDevelopment"},liquid:{title:"Liquid",require:"markup-templating",owner:"cinhtau"},lisp:{title:"Lisp",alias:["emacs","elisp","emacs-lisp"],owner:"JuanCaicedo"},livescript:{title:"LiveScript",owner:"Golmote"},llvm:{title:"LLVM IR",owner:"porglezomp"},log:{title:"Log file",optional:"javastacktrace",owner:"RunDevelopment"},lolcode:{title:"LOLCODE",owner:"Golmote"},lua:{title:"Lua",owner:"Golmote"},magma:{title:"Magma (CAS)",owner:"RunDevelopment"},makefile:{title:"Makefile",owner:"Golmote"},markdown:{title:"Markdown",require:"markup",optional:"yaml",alias:"md",owner:"Golmote"},"markup-templating":{title:"Markup templating",require:"markup",owner:"Golmote"},mata:{title:"Mata",owner:"RunDevelopment"},matlab:{title:"MATLAB",owner:"Golmote"},maxscript:{title:"MAXScript",owner:"RunDevelopment"},mel:{title:"MEL",owner:"Golmote"},mermaid:{title:"Mermaid",owner:"RunDevelopment"},metafont:{title:"METAFONT",owner:"LaeriExNihilo"},mizar:{title:"Mizar",owner:"Golmote"},mongodb:{title:"MongoDB",owner:"airs0urce",require:"javascript"},monkey:{title:"Monkey",owner:"Golmote"},moonscript:{title:"MoonScript",alias:"moon",owner:"RunDevelopment"},n1ql:{title:"N1QL",owner:"TMWilds"},n4js:{title:"N4JS",require:"javascript",optional:"jsdoc",alias:"n4jsd",owner:"bsmith-n4"},"nand2tetris-hdl":{title:"Nand To Tetris HDL",owner:"stephanmax"},naniscript:{title:"Naninovel Script",owner:"Elringus",alias:"nani"},nasm:{title:"NASM",owner:"rbmj"},neon:{title:"NEON",owner:"nette"},nevod:{title:"Nevod",owner:"nezaboodka"},nginx:{title:"nginx",owner:"volado"},nim:{title:"Nim",owner:"Golmote"},nix:{title:"Nix",owner:"Golmote"},nsis:{title:"NSIS",owner:"idleberg"},objectivec:{title:"Objective-C",require:"c",alias:"objc",owner:"uranusjr"},ocaml:{title:"OCaml",owner:"Golmote"},odin:{title:"Odin",owner:"edukisto"},opencl:{title:"OpenCL",require:"c",modify:["c","cpp"],owner:"Milania1"},openqasm:{title:"OpenQasm",alias:"qasm",owner:"RunDevelopment"},oz:{title:"Oz",owner:"Golmote"},parigp:{title:"PARI/GP",owner:"Golmote"},parser:{title:"Parser",require:"markup",owner:"Golmote"},pascal:{title:"Pascal",alias:"objectpascal",aliasTitles:{objectpascal:"Object Pascal"},owner:"Golmote"},pascaligo:{title:"Pascaligo",owner:"DefinitelyNotAGoat"},psl:{title:"PATROL Scripting Language",owner:"bertysentry"},pcaxis:{title:"PC-Axis",alias:"px",owner:"RunDevelopment"},peoplecode:{title:"PeopleCode",alias:"pcode",owner:"RunDevelopment"},perl:{title:"Perl",owner:"Golmote"},php:{title:"PHP",require:"markup-templating",owner:"milesj"},phpdoc:{title:"PHPDoc",require:["php","javadoclike"],modify:"php",owner:"RunDevelopment"},"php-extras":{title:"PHP Extras",require:"php",modify:"php",owner:"milesj"},"plant-uml":{title:"PlantUML",alias:"plantuml",owner:"RunDevelopment"},plsql:{title:"PL/SQL",require:"sql",owner:"Golmote"},powerquery:{title:"PowerQuery",alias:["pq","mscript"],owner:"peterbud"},powershell:{title:"PowerShell",owner:"nauzilus"},processing:{title:"Processing",require:"clike",owner:"Golmote"},prolog:{title:"Prolog",owner:"Golmote"},promql:{title:"PromQL",owner:"arendjr"},properties:{title:".properties",owner:"Golmote"},protobuf:{title:"Protocol Buffers",require:"clike",owner:"just-boris"},pug:{title:"Pug",require:["markup","javascript"],optional:["coffeescript","ejs","handlebars","less","livescript","markdown","scss","stylus","twig"],owner:"Golmote"},puppet:{title:"Puppet",owner:"Golmote"},pure:{title:"Pure",optional:["c","cpp","fortran"],owner:"Golmote"},purebasic:{title:"PureBasic",require:"clike",alias:"pbfasm",owner:"HeX0R101"},purescript:{title:"PureScript",require:"haskell",alias:"purs",owner:"sriharshachilakapati"},python:{title:"Python",alias:"py",owner:"multipetros"},qsharp:{title:"Q#",require:"clike",alias:"qs",owner:"fedonman"},q:{title:"Q (kdb+ database)",owner:"Golmote"},qml:{title:"QML",require:"javascript",owner:"RunDevelopment"},qore:{title:"Qore",require:"clike",owner:"temnroegg"},r:{title:"R",owner:"Golmote"},racket:{title:"Racket",require:"scheme",alias:"rkt",owner:"RunDevelopment"},cshtml:{title:"Razor C#",alias:"razor",require:["markup","csharp"],optional:["css","css-extras","javascript","js-extras"],owner:"RunDevelopment"},jsx:{title:"React JSX",require:["markup","javascript"],optional:["jsdoc","js-extras","js-templates"],owner:"vkbansal"},tsx:{title:"React TSX",require:["jsx","typescript"]},reason:{title:"Reason",require:"clike",owner:"Golmote"},regex:{title:"Regex",owner:"RunDevelopment"},rego:{title:"Rego",owner:"JordanSh"},renpy:{title:"Ren'py",alias:"rpy",owner:"HyuchiaDiego"},rescript:{title:"ReScript",alias:"res",owner:"vmarcosp"},rest:{title:"reST (reStructuredText)",owner:"Golmote"},rip:{title:"Rip",owner:"ravinggenius"},roboconf:{title:"Roboconf",owner:"Golmote"},robotframework:{title:"Robot Framework",alias:"robot",owner:"RunDevelopment"},ruby:{title:"Ruby",require:"clike",alias:"rb",owner:"samflores"},rust:{title:"Rust",owner:"Golmote"},sas:{title:"SAS",optional:["groovy","lua","sql"],owner:"Golmote"},sass:{title:"Sass (Sass)",require:"css",optional:"css-extras",owner:"Golmote"},scss:{title:"Sass (SCSS)",require:"css",optional:"css-extras",owner:"MoOx"},scala:{title:"Scala",require:"java",owner:"jozic"},scheme:{title:"Scheme",owner:"bacchus123"},"shell-session":{title:"Shell session",require:"bash",alias:["sh-session","shellsession"],owner:"RunDevelopment"},smali:{title:"Smali",owner:"RunDevelopment"},smalltalk:{title:"Smalltalk",owner:"Golmote"},smarty:{title:"Smarty",require:"markup-templating",optional:"php",owner:"Golmote"},sml:{title:"SML",alias:"smlnj",aliasTitles:{smlnj:"SML/NJ"},owner:"RunDevelopment"},solidity:{title:"Solidity (Ethereum)",alias:"sol",require:"clike",owner:"glachaud"},"solution-file":{title:"Solution file",alias:"sln",owner:"RunDevelopment"},soy:{title:"Soy (Closure Template)",require:"markup-templating",owner:"Golmote"},sparql:{title:"SPARQL",require:"turtle",owner:"Triply-Dev",alias:"rq"},"splunk-spl":{title:"Splunk SPL",owner:"RunDevelopment"},sqf:{title:"SQF: Status Quo Function (Arma 3)",require:"clike",owner:"RunDevelopment"},sql:{title:"SQL",owner:"multipetros"},squirrel:{title:"Squirrel",require:"clike",owner:"RunDevelopment"},stan:{title:"Stan",owner:"RunDevelopment"},stata:{title:"Stata Ado",require:["mata","java","python"],owner:"RunDevelopment"},iecst:{title:"Structured Text (IEC 61131-3)",owner:"serhioromano"},stylus:{title:"Stylus",owner:"vkbansal"},supercollider:{title:"SuperCollider",alias:"sclang",owner:"RunDevelopment"},swift:{title:"Swift",owner:"chrischares"},systemd:{title:"Systemd configuration file",owner:"RunDevelopment"},"t4-templating":{title:"T4 templating",owner:"RunDevelopment"},"t4-cs":{title:"T4 Text Templates (C#)",require:["t4-templating","csharp"],alias:"t4",owner:"RunDevelopment"},"t4-vb":{title:"T4 Text Templates (VB)",require:["t4-templating","vbnet"],owner:"RunDevelopment"},tap:{title:"TAP",owner:"isaacs",require:"yaml"},tcl:{title:"Tcl",owner:"PeterChaplin"},tt2:{title:"Template Toolkit 2",require:["clike","markup-templating"],owner:"gflohr"},textile:{title:"Textile",require:"markup",optional:"css",owner:"Golmote"},toml:{title:"TOML",owner:"RunDevelopment"},tremor:{title:"Tremor",alias:["trickle","troy"],owner:"darach",aliasTitles:{trickle:"trickle",troy:"troy"}},turtle:{title:"Turtle",alias:"trig",aliasTitles:{trig:"TriG"},owner:"jakubklimek"},twig:{title:"Twig",require:"markup-templating",owner:"brandonkelly"},typescript:{title:"TypeScript",require:"javascript",optional:"js-templates",alias:"ts",owner:"vkbansal"},typoscript:{title:"TypoScript",alias:"tsconfig",aliasTitles:{tsconfig:"TSConfig"},owner:"dkern"},unrealscript:{title:"UnrealScript",alias:["uscript","uc"],owner:"RunDevelopment"},uorazor:{title:"UO Razor Script",owner:"jaseowns"},uri:{title:"URI",alias:"url",aliasTitles:{url:"URL"},owner:"RunDevelopment"},v:{title:"V",require:"clike",owner:"taggon"},vala:{title:"Vala",require:"clike",optional:"regex",owner:"TemplarVolk"},vbnet:{title:"VB.Net",require:"basic",owner:"Bigsby"},velocity:{title:"Velocity",require:"markup",owner:"Golmote"},verilog:{title:"Verilog",owner:"a-rey"},vhdl:{title:"VHDL",owner:"a-rey"},vim:{title:"vim",owner:"westonganger"},"visual-basic":{title:"Visual Basic",alias:["vb","vba"],aliasTitles:{vba:"VBA"},owner:"Golmote"},warpscript:{title:"WarpScript",owner:"RunDevelopment"},wasm:{title:"WebAssembly",owner:"Golmote"},"web-idl":{title:"Web IDL",alias:"webidl",owner:"RunDevelopment"},wgsl:{title:"WGSL",owner:"Dr4gonthree"},wiki:{title:"Wiki markup",require:"markup",owner:"Golmote"},wolfram:{title:"Wolfram language",alias:["mathematica","nb","wl"],aliasTitles:{mathematica:"Mathematica",nb:"Mathematica Notebook"},owner:"msollami"},wren:{title:"Wren",owner:"clsource"},xeora:{title:"Xeora",require:"markup",alias:"xeoracube",aliasTitles:{xeoracube:"XeoraCube"},owner:"freakmaxi"},"xml-doc":{title:"XML doc (.net)",require:"markup",modify:["csharp","fsharp","vbnet"],owner:"RunDevelopment"},xojo:{title:"Xojo (REALbasic)",owner:"Golmote"},xquery:{title:"XQuery",require:"markup",owner:"Golmote"},yaml:{title:"YAML",alias:"yml",owner:"hason"},yang:{title:"YANG",owner:"RunDevelopment"},zig:{title:"Zig",owner:"RunDevelopment"}},plugins:{meta:{path:"plugins/{id}/prism-{id}",link:"plugins/{id}/"},"line-highlight":{title:"Line Highlight",description:"Highlights specific lines and/or line ranges."},"line-numbers":{title:"Line Numbers",description:"Line number at the beginning of code lines.",owner:"kuba-kubula"},"show-invisibles":{title:"Show Invisibles",description:"Show hidden characters such as tabs and line breaks.",optional:["autolinker","data-uri-highlight"]},autolinker:{title:"Autolinker",description:"Converts URLs and emails in code to clickable links. Parses Markdown links in comments."},wpd:{title:"WebPlatform Docs",description:'Makes tokens link to WebPlatform.org documentation. The links open in a new tab.'},"custom-class":{title:"Custom Class",description:"This plugin allows you to prefix Prism's default classes (.comment can become .namespace--comment) or replace them with your defined ones (like .editor__comment). You can even add new classes.",owner:"dvkndn",noCSS:!0},"file-highlight":{title:"File Highlight",description:"Fetch external files and highlight them with Prism. Used on the Prism website itself.",noCSS:!0},"show-language":{title:"Show Language",description:"Display the highlighted language in code blocks (inline code does not show the label).",owner:"nauzilus",noCSS:!0,require:"toolbar"},"jsonp-highlight":{title:"JSONP Highlight",description:"Fetch content with JSONP and highlight some interesting content (e.g. GitHub/Gists or Bitbucket API).",noCSS:!0,owner:"nauzilus"},"highlight-keywords":{title:"Highlight Keywords",description:"Adds special CSS classes for each keyword for fine-grained highlighting.",owner:"vkbansal",noCSS:!0},"remove-initial-line-feed":{title:"Remove initial line feed",description:"Removes the initial line feed in code blocks.",owner:"Golmote",noCSS:!0},"inline-color":{title:"Inline color",description:"Adds a small inline preview for colors in style sheets.",require:"css-extras",owner:"RunDevelopment"},previewers:{title:"Previewers",description:"Previewers for angles, colors, gradients, easing and time.",require:"css-extras",owner:"Golmote"},autoloader:{title:"Autoloader",description:"Automatically loads the needed languages to highlight the code blocks.",owner:"Golmote",noCSS:!0},"keep-markup":{title:"Keep Markup",description:"Prevents custom markup from being dropped out during highlighting.",owner:"Golmote",optional:"normalize-whitespace",noCSS:!0},"command-line":{title:"Command Line",description:"Display a command line with a prompt and, optionally, the output/response from the commands.",owner:"chriswells0"},"unescaped-markup":{title:"Unescaped Markup",description:"Write markup without having to escape anything."},"normalize-whitespace":{title:"Normalize Whitespace",description:"Supports multiple operations to normalize whitespace in code blocks.",owner:"zeitgeist87",optional:"unescaped-markup",noCSS:!0},"data-uri-highlight":{title:"Data-URI Highlight",description:"Highlights data-URI contents.",owner:"Golmote",noCSS:!0},toolbar:{title:"Toolbar",description:"Attach a toolbar for plugins to easily register buttons on the top of a code block.",owner:"mAAdhaTTah"},"copy-to-clipboard":{title:"Copy to Clipboard Button",description:"Add a button that copies the code block to the clipboard when clicked.",owner:"mAAdhaTTah",require:"toolbar",noCSS:!0},"download-button":{title:"Download Button",description:"A button in the toolbar of a code block adding a convenient way to download a code file.",owner:"Golmote",require:"toolbar",noCSS:!0},"match-braces":{title:"Match braces",description:"Highlights matching braces.",owner:"RunDevelopment"},"diff-highlight":{title:"Diff Highlight",description:"Highlights the code inside diff blocks.",owner:"RunDevelopment",require:"diff"},"filter-highlight-all":{title:"Filter highlightAll",description:"Filters the elements the highlightAll and highlightAllUnder methods actually highlight.",owner:"RunDevelopment",noCSS:!0},treeview:{title:"Treeview",description:"A language with special styles to highlight file system tree structures.",owner:"Golmote"}}})},7176:(e,t,n)=>{"use strict";var r,o=n(73126),a=n(75795);try{r=[].__proto__===Array.prototype}catch(c){if(!c||"object"!=typeof c||!("code"in c)||"ERR_PROTO_ACCESS"!==c.code)throw c}var i=!!r&&a&&a(Object.prototype,"__proto__"),s=Object,l=s.getPrototypeOf;e.exports=i&&"function"==typeof i.get?o([i.get]):"function"==typeof l&&function(e){return l(null==e?e:s(e))}},7463:(e,t,n)=>{"use strict";var r=n(96763);function o(e,t){var n=e.length;e.push(t);e:for(;0>>1,o=e[r];if(!(0>>1;rs(l,n))cs(u,l)?(e[r]=u,e[c]=n,r=c):(e[r]=l,e[i]=n,r=i);else{if(!(cs(u,n)))break e;e[r]=u,e[c]=n,r=c}}}return t}function s(e,t){var n=e.sortIndex-t.sortIndex;return 0!==n?n:e.id-t.id}if("object"==typeof performance&&"function"==typeof performance.now){var l=performance;t.unstable_now=function(){return l.now()}}else{var c=Date,u=c.now();t.unstable_now=function(){return c.now()-u}}var d=[],p=[],f=1,m=null,h=3,g=!1,b=!1,y=!1,v="function"==typeof setTimeout?setTimeout:null,w="function"==typeof clearTimeout?clearTimeout:null,S="undefined"!=typeof setImmediate?setImmediate:null;function x(e){for(var t=a(p);null!==t;){if(null===t.callback)i(p);else{if(!(t.startTime<=e))break;i(p),t.sortIndex=t.expirationTime,o(d,t)}t=a(p)}}function k(e){if(y=!1,x(e),!b)if(null!==a(d))b=!0,D(A);else{var t=a(p);null!==t&&L(k,t.startTime-e)}}function A(e,n){b=!1,y&&(y=!1,w(I),I=-1),g=!0;var r=h;try{for(x(n),m=a(d);null!==m&&(!(m.expirationTime>n)||e&&!O());){var o=m.callback;if("function"==typeof o){m.callback=null,h=m.priorityLevel;var s=o(m.expirationTime<=n);n=t.unstable_now(),"function"==typeof s?m.callback=s:m===a(d)&&i(d),x(n)}else i(d);m=a(d)}if(null!==m)var l=!0;else{var c=a(p);null!==c&&L(k,c.startTime-n),l=!1}return l}finally{m=null,h=r,g=!1}}"undefined"!=typeof navigator&&void 0!==navigator.scheduling&&void 0!==navigator.scheduling.isInputPending&&navigator.scheduling.isInputPending.bind(navigator.scheduling);var _,P=!1,E=null,I=-1,j=5,C=-1;function O(){return!(t.unstable_now()-Ce||125i?(e.sortIndex=r,o(p,e),null===a(d)&&e===a(p)&&(y?(w(I),I=-1):y=!0,L(k,r-i))):(e.sortIndex=s,o(d,e),b||g||(b=!0,D(A))),e},t.unstable_shouldYield=O,t.unstable_wrapCallback=function(e){var t=h;return function(){var n=h;h=t;try{return e.apply(this,arguments)}finally{h=n}}}},7699:(e,t,n)=>{"use strict";n.d(t,{A:()=>l,G:()=>c});var r=n(96540),o=n(26849),a=n(74848);const i=Symbol("EmptyContext"),s=r.createContext(i);function l(e){let{children:t}=e;const[n,o]=(0,r.useState)(null),i=(0,r.useMemo)((()=>({expandedItem:n,setExpandedItem:o})),[n]);return(0,a.jsx)(s.Provider,{value:i,children:t})}function c(){const e=(0,r.useContext)(s);if(e===i)throw new o.dV("DocSidebarItemsExpandedStateProvider");return e}},8532:(e,t,n)=>{"use strict";n.d(t,{G:()=>b,a:()=>g});var r=n(96540),o=n(61934),a=n(26849),i=n(78749),s=n(53115),l=n(74848);const c=r.createContext(void 0),u="theme",d=(0,i.Wf)(u),p={light:"light",dark:"dark"},f=e=>e===p.dark?p.dark:p.light,m=e=>o.default.canUseDOM?f(document.documentElement.getAttribute("data-theme")):f(e),h=e=>{d.set(f(e))};function g(e){let{children:t}=e;const n=function(){const{colorMode:{defaultMode:e,disableSwitch:t,respectPrefersColorScheme:n}}=(0,s.p)(),[o,a]=(0,r.useState)(m(e));(0,r.useEffect)((()=>{t&&d.del()}),[t]);const i=(0,r.useCallback)((function(t,r){void 0===r&&(r={});const{persist:o=!0}=r;t?(a(t),o&&h(t)):(a(n?window.matchMedia("(prefers-color-scheme: dark)").matches?p.dark:p.light:e),d.del())}),[n,e]);(0,r.useEffect)((()=>{document.documentElement.setAttribute("data-theme",f(o))}),[o]),(0,r.useEffect)((()=>{if(t)return;const e=e=>{if(e.key!==u)return;const t=d.get();null!==t&&i(f(t))};return window.addEventListener("storage",e),()=>window.removeEventListener("storage",e)}),[t,i]);const l=(0,r.useRef)(!1);return(0,r.useEffect)((()=>{if(t&&!n)return;const e=window.matchMedia("(prefers-color-scheme: dark)"),r=()=>{window.matchMedia("print").matches||l.current?l.current=window.matchMedia("print").matches:i(null)};return e.addListener(r),()=>e.removeListener(r)}),[i,t,n]),(0,r.useMemo)((()=>({colorMode:o,setColorMode:i,get isDarkTheme(){return o===p.dark},setLightTheme(){i(p.light)},setDarkTheme(){i(p.dark)}})),[o,i])}();return(0,l.jsx)(c.Provider,{value:n,children:t})}function b(){const e=(0,r.useContext)(c);if(null==e)throw new a.dV("ColorModeProvider","Please see https://docusaurus.io/docs/api/themes/configuration#use-color-mode.");return e}},8722:(e,t,n)=>{var r=n(96763);const o=n(6969),a=n(98380),i=new Set;function s(e){void 0===e?e=Object.keys(o.languages).filter((e=>"meta"!=e)):Array.isArray(e)||(e=[e]);const t=[...i,...Object.keys(Prism.languages)];a(o,e,t).load((e=>{if(!(e in o.languages))return void(s.silent||r.warn("Language does not exist: "+e));const t="./prism-"+e;delete n.c[n(63157).resolve(t)],delete Prism.languages[e],n(63157)(t),i.add(e)}))}s.silent=!1,e.exports=s},9136:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>a});var r=n(96540),o=n(84974);function a(){return(0,r.useContext)(o.o)}},9303:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>u});n(96540);var r=n(18215),o=n(50539),a=n(53115),i=n(56289),s=n(25246);const l={anchorWithStickyNavbar:"anchorWithStickyNavbar_LWe7",anchorWithHideOnScrollNavbar:"anchorWithHideOnScrollNavbar_WYt5"};var c=n(74848);function u(e){let{as:t,id:n,...u}=e;const d=(0,s.A)(),{navbar:{hideOnScroll:p}}=(0,a.p)();if("h1"===t||!n)return(0,c.jsx)(t,{...u,id:void 0});d.collectAnchor(n);const f=(0,o.translate)({id:"theme.common.headingLinkTitle",message:"Direct link to {heading}",description:"Title for link to heading"},{heading:"string"==typeof u.children?u.children:n});return(0,c.jsxs)(t,{...u,className:(0,r.A)("anchor",p?l.anchorWithHideOnScrollNavbar:l.anchorWithStickyNavbar,u.className),id:n,children:[u.children,(0,c.jsx)(i.default,{className:"hash-link",to:`#${n}`,"aria-label":f,title:f,children:"\u200b"})]})}},9394:(e,t,n)=>{"use strict";var r=n(89211);e.exports=function(){return"function"==typeof Object.is?Object.is:r}},9957:(e,t,n)=>{"use strict";var r=Function.prototype.call,o=Object.prototype.hasOwnProperty,a=n(66743);e.exports=a.call(r,o)},10076:e=>{"use strict";e.exports=Function.prototype.call},10487:(e,t,n)=>{"use strict";var r=n(96897),o=n(30655),a=n(73126),i=n(12205);e.exports=function(e){var t=a(arguments),n=e.length-(arguments.length-1);return r(t,1+(n>0?n:0),!0)},o?o(e.exports,"apply",{value:i}):e.exports.apply=i},11002:e=>{"use strict";e.exports=Function.prototype.apply},11514:(e,t,n)=>{"use strict";var r=n(38403);e.exports=function(){return Object.assign?function(){if(!Object.assign)return!1;for(var e="abcdefghijklmnopqrst",t=e.split(""),n={},r=0;r{"use strict";n.d(t,{A:()=>a});var r=!0,o="Invariant failed";function a(e,t){if(!e){if(r)throw new Error(o);var n="function"==typeof t?t():t,a=n?"".concat(o,": ").concat(n):o;throw new Error(a)}}},11861:(e,t,n)=>{"use strict";function r(e,t){return void 0===t&&(t=(e,t)=>e===t),e.filter(((n,r)=>e.findIndex((e=>t(e,n)))!==r))}function o(e){return Array.from(new Set(e))}function a(e,t){const n={};let r=0;for(const o of e){const e=t(o,r);n[e]??=[],n[e].push(o),r+=1}return n}n.d(t,{$z:()=>a,XI:()=>r,sb:()=>o})},12205:(e,t,n)=>{"use strict";var r=n(66743),o=n(11002),a=n(13144);e.exports=function(){return a(r,o,arguments)}},12862:(e,t,n)=>{"use strict";n.d(t,{A:()=>u});n(96540);var r=n(56289),o=n(29030),a=n(40797),i=n(53115),s=n(24475),l=n(74848);function c(e){let{logo:t,alt:n,imageClassName:r}=e;const a={light:(0,o.default)(t.src),dark:(0,o.default)(t.srcDark||t.src)},i=(0,l.jsx)(s.default,{className:t.className,sources:a,height:t.height,width:t.width,alt:n,style:t.style});return r?(0,l.jsx)("div",{className:r,children:i}):i}function u(e){const{siteConfig:{title:t}}=(0,a.default)(),{navbar:{title:n,logo:s}}=(0,i.p)(),{imageClassName:u,titleClassName:d,...p}=e,f=(0,o.default)(s?.href||"/"),m=n?"":t,h=s?.alt??m;return(0,l.jsxs)(r.default,{to:f,...p,...s?.target&&{target:s.target},children:[s&&(0,l.jsx)(c,{logo:s,alt:h,imageClassName:u}),null!=n&&(0,l.jsx)("b",{className:d,children:n})]})}},13003:e=>{"use strict";e.exports=function(e){return e!=e}},13144:(e,t,n)=>{"use strict";var r=n(66743),o=n(11002),a=n(10076),i=n(47119);e.exports=i||r.call(a,o)},13722:(e,t,n)=>{"use strict";n.d(t,{A:()=>o});const r=e=>"object"==typeof e&&!!e&&Object.keys(e).length>0;function o(e){const t={};return function e(n,o){Object.entries(n).forEach((n=>{let[a,i]=n;const s=o?`${o}.${a}`:a;r(i)?e(i,s):t[s]=i}))}(e),t}},14035:(e,t,n)=>{"use strict";var r,o=n(36556),a=n(49092)(),i=n(9957),s=n(75795);if(a){var l=o("RegExp.prototype.exec"),c={},u=function(){throw c},d={toString:u,valueOf:u};"symbol"==typeof Symbol.toPrimitive&&(d[Symbol.toPrimitive]=u),r=function(e){if(!e||"object"!=typeof e)return!1;var t=s(e,"lastIndex");if(!(t&&i(t,"value")))return!1;try{l(e,d)}catch(n){return n===c}}}else{var p=o("Object.prototype.toString");r=function(e){return!(!e||"object"!=typeof e&&"function"!=typeof e)&&"[object RegExp]"===p(e)}}e.exports=r},15066:(e,t,n)=>{"use strict";function r(e){var t,n,o="";if("string"==typeof e||"number"==typeof e)o+=e;else if("object"==typeof e)if(Array.isArray(e)){var a=e.length;for(t=0;to});const o=function(){for(var e,t,n=0,o="",a=arguments.length;n{"use strict";var n=Symbol.for("react.element"),r=Symbol.for("react.portal"),o=Symbol.for("react.fragment"),a=Symbol.for("react.strict_mode"),i=Symbol.for("react.profiler"),s=Symbol.for("react.provider"),l=Symbol.for("react.context"),c=Symbol.for("react.forward_ref"),u=Symbol.for("react.suspense"),d=Symbol.for("react.memo"),p=Symbol.for("react.lazy"),f=Symbol.iterator;var m={isMounted:function(){return!1},enqueueForceUpdate:function(){},enqueueReplaceState:function(){},enqueueSetState:function(){}},h=Object.assign,g={};function b(e,t,n){this.props=e,this.context=t,this.refs=g,this.updater=n||m}function y(){}function v(e,t,n){this.props=e,this.context=t,this.refs=g,this.updater=n||m}b.prototype.isReactComponent={},b.prototype.setState=function(e,t){if("object"!=typeof e&&"function"!=typeof e&&null!=e)throw Error("setState(...): takes an object of state variables to update or a function which returns an object of state variables.");this.updater.enqueueSetState(this,e,t,"setState")},b.prototype.forceUpdate=function(e){this.updater.enqueueForceUpdate(this,e,"forceUpdate")},y.prototype=b.prototype;var w=v.prototype=new y;w.constructor=v,h(w,b.prototype),w.isPureReactComponent=!0;var S=Array.isArray,x=Object.prototype.hasOwnProperty,k={current:null},A={key:!0,ref:!0,__self:!0,__source:!0};function _(e,t,r){var o,a={},i=null,s=null;if(null!=t)for(o in void 0!==t.ref&&(s=t.ref),void 0!==t.key&&(i=""+t.key),t)x.call(t,o)&&!A.hasOwnProperty(o)&&(a[o]=t[o]);var l=arguments.length-2;if(1===l)a.children=r;else if(1{"use strict";n.d(t,{A:()=>a});n(96540);const r={iconExternalLink:"iconExternalLink_nPIU"};var o=n(74848);function a(e){let{width:t=13.5,height:n=13.5}=e;return(0,o.jsx)("svg",{width:t,height:n,"aria-hidden":"true",viewBox:"0 0 24 24",className:r.iconExternalLink,children:(0,o.jsx)("path",{fill:"currentColor",d:"M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"})})}},17081:(e,t,n)=>{"use strict";n.d(t,{_:()=>s,u:()=>l});var r=n(96540),o=n(26849),a=n(74848);const i=r.createContext(null);function s(e){let{children:t,content:n}=e;const o=function(e){return(0,r.useMemo)((()=>({metadata:e.metadata,frontMatter:e.frontMatter,assets:e.assets,contentTitle:e.contentTitle,toc:e.toc})),[e])}(n);return(0,a.jsx)(i.Provider,{value:o,children:t})}function l(){const e=(0,r.useContext)(i);if(null===e)throw new o.dV("DocProvider");return e}},18215:(e,t,n)=>{"use strict";function r(e){var t,n,o="";if("string"==typeof e||"number"==typeof e)o+=e;else if("object"==typeof e)if(Array.isArray(e)){var a=e.length;for(t=0;to});const o=function(){for(var e,t,n=0,o="",a=arguments.length;n{var r={"./":8722};function o(e){var t=a(e);return n(t)}function a(e){if(!n.o(r,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return r[e]}o.keys=function(){return Object.keys(r)},o.resolve=a,e.exports=o,o.id=18692},19585:(e,t,n)=>{"use strict";n.d(t,{K:()=>p,j:()=>l});var r=n(96540),o=n(56347),a=n(50539),i=n(77685),s=n(74848);const l="__docusaurus_skipToContent_fallback";function c(e){e.setAttribute("tabindex","-1"),e.focus(),e.removeAttribute("tabindex")}function u(){const e=(0,r.useRef)(null),{action:t}=(0,o.W6)(),n=(0,r.useCallback)((e=>{e.preventDefault();const t=document.querySelector("main:first-of-type")??document.getElementById(l);t&&c(t)}),[]);return(0,i.$)((n=>{let{location:r}=n;e.current&&!r.hash&&"PUSH"===t&&c(e.current)})),{containerRef:e,onClick:n}}const d=(0,a.translate)({id:"theme.common.skipToMainContent",description:"The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation",message:"Skip to main content"});function p(e){const t=e.children??d,{containerRef:n,onClick:r}=u();return(0,s.jsx)("div",{ref:n,role:"region","aria-label":d,children:(0,s.jsx)("a",{...e,href:`#${l}`,onClick:r,children:t})})}},19700:()=>{!function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,r,o,a){if(n.language===r){var i=n.tokenStack=[];n.code=n.code.replace(o,(function(e){if("function"==typeof a&&!a(e))return e;for(var o,s=i.length;-1!==n.code.indexOf(o=t(r,s));)++s;return i[s]=e,o})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,r){if(n.language===r&&n.tokenStack){n.grammar=e.languages[r];var o=0,a=Object.keys(n.tokenStack);!function i(s){for(var l=0;l=a.length);l++){var c=s[l];if("string"==typeof c||c.content&&"string"==typeof c.content){var u=a[o],d=n.tokenStack[u],p="string"==typeof c?c:c.content,f=t(r,u),m=p.indexOf(f);if(m>-1){++o;var h=p.substring(0,m),g=new e.Token(r,e.tokenize(d,n.grammar),"language-"+r,d),b=p.substring(m+f.length),y=[];h&&y.push.apply(y,i([h])),y.push(g),b&&y.push.apply(y,i([b])),"string"==typeof c?s.splice.apply(s,[l,1].concat(y)):c.content=y}}else c.content&&i(c.content)}return s}(n.tokens)}}}})}(Prism)},20311:e=>{"use strict";e.exports=function(e,t,n,r,o,a,i,s){if(!e){var l;if(void 0===t)l=new Error("Minified exception occurred; use the non-minified dev environment for the full error message and additional helpful warnings.");else{var c=[n,r,o,a,i,s],u=0;(l=new Error(t.replace(/%s/g,(function(){return c[u++]})))).name="Invariant Violation"}throw l.framesToPop=1,l}}},21020:(e,t,n)=>{"use strict";var r=n(96540),o=Symbol.for("react.element"),a=Symbol.for("react.fragment"),i=Object.prototype.hasOwnProperty,s=r.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED.ReactCurrentOwner,l={key:!0,ref:!0,__self:!0,__source:!0};function c(e,t,n){var r,a={},c=null,u=null;for(r in void 0!==n&&(c=""+n),void 0!==t.key&&(c=""+t.key),void 0!==t.ref&&(u=t.ref),t)i.call(t,r)&&!l.hasOwnProperty(r)&&(a[r]=t[r]);if(e&&e.defaultProps)for(r in t=e.defaultProps)void 0===a[r]&&(a[r]=t[r]);return{$$typeof:o,type:e,key:c,ref:u,props:a,_owner:s.current}}t.Fragment=a,t.jsx=c,t.jsxs=c},21858:(e,t,n)=>{"use strict";n.d(t,{n:()=>s,r:()=>l});var r=n(96540),o=n(26849),a=n(74848);const i=r.createContext(null);function s(e){let{children:t,version:n}=e;return(0,a.jsx)(i.Provider,{value:n,children:t})}function l(){const e=(0,r.useContext)(i);if(null===e)throw new o.dV("DocsVersionProvider");return e}},22306:(e,t,n)=>{"use strict";n.d(t,{V:()=>l,t:()=>c});var r=n(96540),o=n(26849),a=n(74848);const i=Symbol("EmptyContext"),s=r.createContext(i);function l(e){let{children:t,name:n,items:o}=e;const i=(0,r.useMemo)((()=>n&&o?{name:n,items:o}:null),[n,o]);return(0,a.jsx)(s.Provider,{value:i,children:t})}function c(){const e=(0,r.useContext)(s);if(e===i)throw new o.dV("DocsSidebarProvider");return e}},22551:(e,t,n)=>{"use strict";var r=n(96763),o=n(96540),a=n(69982);function i(e){for(var t="https://reactjs.org/docs/error-decoder.html?invariant="+e,n=1;n