"use strict";(self.webpackChunkpingvindocs=self.webpackChunkpingvindocs||[]).push([[695],{1897:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>a,frontMatter:()=>r,metadata:()=>o,toc:()=>c});var i=n(4848),s=n(8453);const r={id:"s3"},l="S3",o={id:"setup/s3",title:"S3",description:"You are able to add your preferred S3 provider, like AWS, DigitalOcean, Exoscale or Infomaniak. However, if you don't",source:"@site/docs/setup/s3.md",sourceDirName:"setup",slug:"/setup/s3",permalink:"/pingvin-share/setup/s3",draft:!1,unlisted:!1,editUrl:"https://github.com/stonith404/pingvin-share/edit/main/docs/docs/setup/s3.md",tags:[],version:"current",frontMatter:{id:"s3"},sidebar:"docsSidebar",previous:{title:"OAuth 2 Login Guide",permalink:"/pingvin-share/setup/oauth2login"},next:{title:"Upgrading",permalink:"/pingvin-share/setup/upgrading"}},d={},c=[{value:"Configuration",id:"configuration",level:2},{value:"ClamAV",id:"clamav",level:2},{value:"ZIP",id:"zip",level:2}];function h(e){const t={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"s3",children:"S3"})}),"\n",(0,i.jsxs)(t.p,{children:["You are able to add your preferred S3 provider, like AWS, DigitalOcean, Exoscale or Infomaniak. However, if you don't\nwant to store your files on a S3 bucket, you don't have to. Consider that this feature is ",(0,i.jsx)(t.code,{children:"DISABLED"})," per default."]}),"\n",(0,i.jsx)(t.h2,{id:"configuration",children:"Configuration"}),"\n",(0,i.jsxs)(t.p,{children:["You can configure your S3 provider and bucket by going to the configuration page in your admin dashboard ",(0,i.jsx)(t.code,{children:"/admin/config/s3"}),"."]}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{style:{textAlign:"left"},children:"Key"}),(0,i.jsx)(t.th,{style:{textAlign:"left"},children:"Description"}),(0,i.jsx)(t.th,{style:{textAlign:"left"},children:"Value"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"left"},children:"enabled"}),(0,i.jsx)(t.td,{style:{textAlign:"left"},children:"This property enables the storage location on your configured S3 bucket."}),(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"true"})})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"left"},children:"endpoint"}),(0,i.jsx)(t.td,{style:{textAlign:"left"},children:"This property is the host from your S3 bucket."}),(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"sos-ch-dk-2"})})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"left"},children:"region"}),(0,i.jsx)(t.td,{style:{textAlign:"left"},children:"This property is the region where the bucket is located."}),(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"sos-ch-dk-2.exo.io"})})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"left"},children:"bucketName"}),(0,i.jsx)(t.td,{style:{textAlign:"left"},children:"This property is the name of your S3 bucket."}),(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"my-bucket"})})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"left"},children:"bucketPath"}),(0,i.jsx)(t.td,{style:{textAlign:"left"},children:"This property defines the folder where you want to store your files which are uploaded. Hint: Don't put a slash in the start or end."}),(0,i.jsxs)(t.td,{style:{textAlign:"left"},children:[(0,i.jsx)(t.code,{children:"my/custom/path"})," (or leave it empty for root)"]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"left"},children:"key"}),(0,i.jsx)(t.td,{style:{textAlign:"left"},children:"This is the access key you need to access to your bucket."}),(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"key-asdf"})})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"left"},children:"secret"}),(0,i.jsx)(t.td,{style:{textAlign:"left"},children:"This is the secret you need to access to your bucket."}),(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"secret-asdf"})})]})]})]}),"\n",(0,i.jsx)(t.p,{children:"Don't forget to save the configuration. :)"}),"\n",(0,i.jsx)(t.h2,{id:"clamav",children:"ClamAV"}),"\n",(0,i.jsx)(t.p,{children:"Consider that ClamAV scans are not available at the moment if you store your files in a S3 bucket."}),"\n",(0,i.jsx)(t.h2,{id:"zip",children:"ZIP"}),"\n",(0,i.jsx)(t.p,{children:"Creating ZIP archives is not currently supported if you store your files in an S3 bucket."})]})}function a(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>l,x:()=>o});var i=n(6540);const s={},r=i.createContext(s);function l(e){const t=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),i.createElement(r.Provider,{value:t},e.children)}}}]);