mirror of
https://github.com/openziti/zrok.git
synced 2025-01-24 14:59:08 +01:00
1 line
16 KiB
JavaScript
1 line
16 KiB
JavaScript
|
"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[4778],{3938:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>u,frontMatter:()=>c,metadata:()=>d,toc:()=>h});var s=r(5893),i=r(1151);function o(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",li:"li",ol:"ol",p:"p",pre:"pre",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h2,{id:"docker-quickstart",children:"Docker Quickstart"}),"\n",(0,s.jsx)("iframe",{width:"100%",height:"315",src:"https://www.youtube.com/embed/zoWmTzTa1cg",title:"YouTube video player",frameborder:"0",allow:"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share",allowfullscreen:!0}),"\n",(0,s.jsx)(n.h3,{id:"dns-configuration",children:"DNS Configuration"}),"\n",(0,s.jsx)(n.p,{children:"The quickstart makes these assumptions about your global DNS configuration."}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["A Caddy DNS plugin is available for your DNS provider (see ",(0,s.jsx)(n.a,{href:"https://github.com/orgs/caddy-dns/repositories?type=all&q=sort%3Aname-asc",children:"github.com/caddy-dns"}),")"]}),"\n",(0,s.jsxs)(n.li,{children:["You have designated A DNS zone for zrok, e.g. ",(0,s.jsx)(n.code,{children:"example.com"})," or ",(0,s.jsx)(n.code,{children:"share.example.com"})," and created (and delegated, if necessary) the zone on your DNS provider's platform."]}),"\n",(0,s.jsxs)(n.li,{children:["A wildcard record exists for the IP address where the zrok instance will run, e.g. if your DNS zone is ",(0,s.jsx)(n.code,{children:"share.example.com"}),", then your wildcard record is ",(0,s.jsx)(n.code,{children:"*.share.example.com"}),"."]}),"\n",(0,s.jsx)(n.li,{children:"You have created an API token in your DNS provider's platform and the token has permission to create DNS records in the DNS zone."}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"create-the-docker-compose-project",children:"Create the Docker Compose Project"}),"\n",(0,s.jsx)(n.p,{children:'Create a working directory on your Docker host and save these Docker Compose project files. A OpenZiti network is provided by the "quickstart" container and is managed exclusively by zrok.'}),"\n",(0,s.jsx)(n.h4,{id:"shortcut-option",children:"Shortcut Option"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Run this script to download the files in the current directory."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"curl https://get.openziti.io/zrok-instance/fetch.bash | bash\n"})}),"\n",(0,s.jsx)(n.p,{children:"Or, specify the Compose project directory."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"curl https://get.openziti.io/zrok-instance/fetch.bash | bash -s /path/to/compose/project/dir\n"})}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"manual-option",children:"Manual Option"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Get the zrok repo ZIP file."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"wget https://github.com/openziti/zrok/archive/refs/heads/main.zip\n"})}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"Unzip the zrok-instance files into the project directory."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"unzip -j -d . main.zip '*/docker/compose/zrok-instance/*'\n"})}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"configure-the-docker-compose-project-environment",children:"Configure the Docker Compose Project Environment"}),"\n",(0,s.jsxs)(n.p,{children:["Create an ",(0,s.jsx)(n.code,{children:".env"})," file in the working directory."]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",metastring:'title=".env required"',children:"ZROK_DNS_ZONE=share.example.com\n\nCADDY_DNS_PLUGIN=cloudflare\nCADDY_DNS_PLUGIN_TOKEN=abcd1234\nCADDY_ACME_EMAIL=me@example.com\n\nZITI_PWD=zitiadminpw\n\nZROK_ADMIN_TOKEN=zrokto
|