mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-07 10:17:39 +02:00
1 line
10 KiB
JavaScript
1 line
10 KiB
JavaScript
"use strict";(globalThis.webpackChunkOpenSign_Docs=globalThis.webpackChunkOpenSign_Docs||[]).push([[1170],{71723(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":6,"frontMatter":{"sidebar_position":6,"title":"Custom File Storage"},"sidebar":"tutorialSidebar","previous":{"title":"Mail","permalink":"/docs/help/User Menu/Console/emails"},"next":{"title":"Custom Signing Certificate","permalink":"/docs/help/User Menu/Console/signing_certificate"}}');var t=s(74848),r=s(28453);const i={sidebar_position:6,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)}},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)}}}]); |