extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2024-11-07 08:44:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

deploy: ba82048f24

Browse Source
This commit is contained in:
qrkourier 2024-05-13 19:04:10 +00:00
parent 36e24ece0b
commit 7799703585
48 changed files with 314 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
404.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

1
assets/js/e1dfe4fe.54d38c3a.js Normal file
View File

File diff suppressed because one or more lines are too long

1
assets/js/e1dfe4fe.60f30fb4.js
View File

File diff suppressed because one or more lines are too long

2
assets/js/runtime~main.fa10fe9b.js → assets/js/runtime~main.757cf1b2.js
View File

File diff suppressed because one or more lines are too long

2
docs/category/guides/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/category/metrics-and-limits/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/category/oauth/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/category/self-hosting/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/concepts/files/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/concepts/hosting/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/concepts/http/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/concepts/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/concepts/opensource/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/concepts/sharing-private/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/concepts/sharing-public/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/concepts/sharing-reserved/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/concepts/tunnels/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/getting-started/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/docker-share/docker_private_share_guide/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/docker-share/docker_public_share_guide/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/docker-share/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/drives/cli/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/frontdoor/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/install/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/install/linux/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/install/macos/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/install/windows/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/permission-modes/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

30
docs/guides/self-hosting/docker/index.html
View File

File diff suppressed because one or more lines are too long

2
docs/guides/self-hosting/instance-configuration/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/self-hosting/linux/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/self-hosting/linux/nginx/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/self-hosting/metrics-and-limits/configuring-limits/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/self-hosting/metrics-and-limits/configuring-metrics/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/self-hosting/oauth/configuring-oauth/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/vpn/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
search/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e053e05e.css">
<script src="/assets/js/runtime~main.fa10fe9b.js" defer="defer"></script>
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

3
zrok-instance/.gitignore vendored
View File

@ -1,2 +1 @@
/.env
/compose.yml
/.env

2
zrok-instance/Caddyfile
View File

@ -1,5 +1,5 @@
{
email {$CADDY_ACME_EMAIL}
email {$ZROK_USER_EMAIL}
acme_ca {$CADDY_ACME_API}
admin 0.0.0.0:2019
}

59
zrok-instance/README.md
View File

@ -1,20 +1,25 @@
## Docker Instance
<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></iframe>
<iframe width="100%" height="315" src="https://www.youtube.com/embed/70zJ_h4uiD8" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
This Docker Compose project creates a zrok instance and includes a ziti controller and router. An optional Caddy container is included to provide HTTPS and reverse proxy services for the zrok API and public shares.
### DNS Configuration
The Compose project makes these assumptions about your global DNS configuration.
1. A Caddy DNS plugin is available for your DNS provider (see [github.com/caddy-dns](https://github.com/orgs/caddy-dns/repositories?type=all&q=sort%3Aname-asc))
1. You have designated A DNS zone for zrok, e.g. `example.com` or `share.example.com` and created (and delegated, if necessary) the zone on your DNS provider's platform.
1. A wildcard record exists for the IP address where the zrok instance will run, e.g. if your DNS zone is `share.example.com`, then your wildcard record is `*.share.example.com`.
1. 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.
#### Additional DNS Configuration for Caddy TLS
The included Caddy container can automatically manage a wildcard certificate for your zrok instance. You can enable Caddy in this compose project by renaming `caddy.compose.override.yml` as `compose.override.yml`.
1. Ensure A Caddy DNS plugin is available for your DNS provider (see [github.com/caddy-dns](https://github.com/orgs/caddy-dns/repositories?type=all&q=sort%3Aname-asc)).
1. Designate A DNS zone for zrok, e.g. `example.com` or `share.example.com` and create the zone on your DNS provider's platform.
1. Created an API token in your DNS provider that has permission to manage zrok's DNS zone.
### Create the Docker Compose Project
Create a working directory on your Docker host and save these Docker Compose project files. A OpenZiti network is provided by the "ziti-quickstart" container and is managed exclusively by zrok.
Create a working directory on your Docker host and save these Docker Compose project files.
#### Shortcut Option
@ -51,17 +56,26 @@ Create an `.env` file in the working directory.
```bash title=".env required"
ZROK_DNS_ZONE=share.example.com
CADDY_DNS_PLUGIN=cloudflare
CADDY_DNS_PLUGIN_TOKEN=abcd1234
CADDY_ACME_EMAIL=me@example.com
ZROK_USER_EMAIL=me@example.com
ZROK_USER_PWD=zrokuserpw
ZITI_PWD=zitiadminpw
ZROK_ADMIN_TOKEN=zroktoken
ZROK_USER_PWD=zrokuserpw
```
```bash title=".env options"
# plugin name for your DNS provider
CADDY_DNS_PLUGIN=cloudflare
# API token from your DNS provider
CADDY_DNS_PLUGIN_TOKEN=abcd1234
# use the staging API until you're sure everything is working to avoid hitting the rate limit
CADDY_ACME_API=https://acme-staging-v02.api.letsencrypt.org/directory
# zrok version, e.g., 1.0.0
ZROK_IMAGE_TAG=latest
# ziti version, e.g., 1.0.0
ZITI_IMAGE_TAG=latest
# ziti ports
ZITI_CTRL_ADVERTISED_PORT=1280
ZITI_ROUTER_PORT=3022
@ -72,9 +86,6 @@ ZROK_OAUTH_GITHUB_CLIENT_ID=abcd1234
ZROK_OAUTH_GITHUB_CLIENT_SECRET=abcd1234
ZROK_OAUTH_GOOGLE_CLIENT_ID=abcd1234
ZROK_OAUTH_GOOGLE_CLIENT_SECRET=abcd1234
# use the staging API until you're sure everything is working to avoid hitting the main CA's rate limit
CADDY_ACME_API=https://acme-staging-v02.api.letsencrypt.org/directory
```
### Start the Docker Compose Project
@ -89,10 +100,10 @@ CADDY_ACME_API=https://acme-staging-v02.api.letsencrypt.org/directory
### Set up a User Account
This step creates a user account. You will log in to the zrok web console with the account password created in this step. The CADDY_ACME_EMAIL and ZROK_USER_PWD variables are set in the `.env` file. You can create more user accounts the same way by substituting a different email and password.
This step creates a user account. You will log in to the zrok web console with the account password created in this step. The ZROK_USER_EMAIL and ZROK_USER_PWD variables are set in the `.env` file. You can create more user accounts the same way by substituting a different email and password.
```bash
docker compose exec zrok-controller bash -xc 'zrok admin create account /etc/zrok-controller/config.yml ${CADDY_ACME_EMAIL} ${ZROK_USER_PWD}'
```bash title="Create the first user account"
docker compose exec zrok-controller bash -xc 'zrok admin create account /etc/zrok-controller/config.yml ${ZROK_USER_EMAIL} ${ZROK_USER_PWD}'
```
```buttonless title="Example output"
@ -102,6 +113,12 @@ docker compose exec zrok-controller bash -xc 'zrok admin create account /etc/zro
heMqncCyxZcx
```
Create additional users by running the command again with a different email and password.
```bash title="Create another user"
docker compose exec zrok-controller zrok admin create account /etc/zrok-controller/config.yml <email> <password>
```
### Enable the User Environment
You must enable each device environment with the account token obtained when the account was created. This is separate from the account password that's used to log in to the web console.
@ -114,6 +131,12 @@ Follow [the getting started guide](/docs/getting-started#installing-the-zrok-com
zrok config set apiEndpoint https://zrok.share.example.com
```
or, if not using Caddy for TLS:
```bash
zrok config set apiEndpoint http://zrok.share.example.com:18080
```
1. Enable an environment on this device with the account token from the previous step.
```bash

4
zrok-instance/bootstrap-frontend.bash
View File

@ -106,11 +106,11 @@ if [[ -n "${ZROK_PUBLIC_TOKEN}" ]]; then
echo "INFO: updating frontend"
zrok admin update frontend "${ZROK_PUBLIC_TOKEN}" \
--url-template "https://{token}.${ZROK_DNS_ZONE}"
--url-template "${ZROK_FRONTEND_SCHEME}://{token}.${ZROK_DNS_ZONE}:${ZROK_FRONTEND_PORT}"
else
echo "INFO: creating frontend"
zrok admin create frontend "${ZITI_PUBLIC_ID}" public \
"https://{token}.${ZROK_DNS_ZONE}"
"${ZROK_FRONTEND_SCHEME}://{token}.${ZROK_DNS_ZONE}:${ZROK_FRONTEND_PORT}"
fi
exec "${@}"

41
zrok-instance/caddy.compose.override.yml Normal file
View File

@ -0,0 +1,41 @@
# delete this file from your compose project if you do not want to use Caddy for TLS termination
services:
caddy:
build:
context: .
dockerfile: ./caddy.Dockerfile
args:
CADDY_DNS_PLUGIN: ${CADDY_DNS_PLUGIN} # e.g., "digitalocean" (see github.com/caddy-dns)
restart: unless-stopped
environment:
CADDY_DNS_PLUGIN: ${CADDY_DNS_PLUGIN} # e.g., "digitalocean" (see github.com/caddy-dns)
CADDY_DNS_PLUGIN_TOKEN: ${CADDY_DNS_PLUGIN_TOKEN} # API token from DNS provider used by plugin to solve the ACME challenge
ZROK_USER_EMAIL: ${ZROK_USER_EMAIL} # email address sent to CA for ACME account and renewal notifications
CADDY_ACME_API: ${CADDY_ACME_API:-https://acme-v02.api.letsencrypt.org/directory} # ACME API endpoint
ZROK_DNS_ZONE: ${ZROK_DNS_ZONE} # e.g., "example.com" or "127.0.0.1.sslip.io"
ZROK_CTRL_PORT: ${ZROK_CTRL_PORT:-18080}
ZROK_FRONTEND_PORT: ${ZROK_FRONTEND_PORT:-8080}
ZROK_OAUTH_PORT: ${ZROK_OAUTH_PORT:-8081}
expose:
- 80/tcp
- 443/tcp
- 443/udp # Caddy's HTTP/3 (QUIC) (not published)
- 2019/tcp # Caddy's admin API (not published)
ports:
- ${CADDY_INTERFACE:-0.0.0.0}:80:80
- ${CADDY_INTERFACE:-0.0.0.0}:443:443
# - ${CADDY_INTERFACE:-0.0.0.0}:443:443/udp" # future: HTTP/3 (QUIC)
volumes:
- caddy_data:/data
- caddy_config:/config
networks:
zrok-instance:
zrok-frontend:
environment:
ZROK_FRONTEND_SCHEME: https
ZROK_FRONTEND_PORT: 443
volumes:
caddy_data:
caddy_config:

167
zrok-instance/compose.yml Normal file
View File

@ -0,0 +1,167 @@
services:
ziti-quickstart:
image: ${ZITI_CLI_IMAGE:-docker.io/openziti/ziti-cli}:${ZITI_CLI_TAG:-latest}
restart: unless-stopped
networks:
zrok-instance:
# this allows other containers to use the same external DNS name to reach the quickstart container from within the
# Docker network that clients outside the Docker network use to reach the quickstart container via port forwarding
aliases:
- ziti.${ZROK_DNS_ZONE}
entrypoint:
- bash
- -euc
- |
ZITI_CMD+=" --ctrl-address ziti.${ZROK_DNS_ZONE}"\
" --ctrl-port ${ZITI_CTRL_ADVERTISED_PORT:-1280}"\
" --router-address ziti.${ZROK_DNS_ZONE}"\
" --router-port ${ZITI_ROUTER_PORT:-3022}"\
" --password ${ZITI_PWD:-admin}"
echo "DEBUG: run command is: ziti $${@} $${ZITI_CMD}"
exec ziti "$${@}" $${ZITI_CMD}
command: -- edge quickstart --home /home/ziggy/quickstart
user: ${ZIGGY_UID:-1000}
environment:
HOME: /home/ziggy
PFXLOG_NO_JSON: "${PFXLOG_NO_JSON:-true}"
ZITI_ROUTER_NAME: ${ZITI_ROUTER_NAME:-quickstart-router}
volumes:
# store the quickstart state in a named volume "ziti_home" or store the quickstart state on the Docker host in a
# directory, ZITI_HOME
- ${ZITI_HOME:-ziti_home}:/home/ziggy
ports:
- ${ZITI_INTERFACE:-0.0.0.0}:${ZITI_CTRL_ADVERTISED_PORT:-1280}:${ZITI_CTRL_ADVERTISED_PORT:-1280}
- ${ZITI_INTERFACE:-0.0.0.0}:${ZITI_ROUTER_PORT:-3022}:${ZITI_ROUTER_PORT:-3022}
expose:
- ${ZITI_CTRL_ADVERTISED_PORT:-1280}
- ${ZITI_ROUTER_PORT:-3022}
depends_on:
ziti-quickstart-init:
condition: service_completed_successfully
healthcheck:
test:
- CMD
- ziti
- agent
- stats
interval: 3s
timeout: 3s
retries: 5
start_period: 30s
# this service is used to initialize the ziti_home volume by setting the owner to the UID of the user running the
# quickstart container
ziti-quickstart-init:
image: busybox
command: chown -Rc ${ZIGGY_UID:-1000} /home/ziggy
user: root
environment:
HOME: /home/ziggy
volumes:
# store the quickstart state in a named volume "ziti_home" or store the quickstart state on the Docker host in a
# directory, ZITI_HOME
- ${ZITI_HOME:-ziti_home}:/home/ziggy
# add a health check for the quickstart network
ziti-quickstart-check:
image: busybox
command: echo "Ziti is cooking"
depends_on:
ziti-quickstart:
condition: service_healthy
zrok-permissions:
image: busybox
command:
- /bin/sh
- -euxc
- |
chown -Rc ${ZIGGY_UID:-2171} /var/lib/zrok-*;
chmod -Rc ug=rwX,o-rwx /var/lib/zrok-*;
volumes:
- zrok_ctrl:/var/lib/zrok-controller
- zrok_frontend:/var/lib/zrok-frontend
zrok-controller:
depends_on:
zrok-permissions:
condition: service_completed_successfully
build:
context: .
dockerfile: ./zrok-controller.Dockerfile
args:
ZROK_CLI_IMAGE: ${ZROK_CLI_IMAGE:-openziti/zrok}
ZROK_CLI_TAG: ${ZROK_CLI_TAG:-latest}
ZROK_DNS_ZONE: ${ZROK_DNS_ZONE} # e.g., "example.com" or "127.0.0.1.sslip.io"
ZITI_CTRL_ADVERTISED_PORT: ${ZITI_CTRL_ADVERTISED_PORT:-1280}
ZROK_ADMIN_TOKEN: ${ZROK_ADMIN_TOKEN} # zrok controller admin password
ZROK_CTRL_PORT: ${ZROK_CTRL_PORT:-18080}
ZITI_PWD: ${ZITI_PWD} # ziti controller admin password
user: ${ZIGGY_UID:-2171}
command: zrok controller /etc/zrok-controller/config.yml --verbose
volumes:
- zrok_ctrl:/var/lib/zrok-controller
networks:
zrok-instance:
aliases:
- zrok.${ZROK_DNS_ZONE}
restart: unless-stopped
expose:
- ${ZROK_CTRL_PORT:-18080} # (not published)
ports:
- 127.0.0.1:${ZROK_CTRL_PORT:-18080}:${ZROK_CTRL_PORT:-18080}
environment:
ZROK_USER_PWD: ${ZROK_USER_PWD} # admin account password (initial user account)
ZROK_USER_EMAIL: ${ZROK_USER_EMAIL} # login email address (initial user account)
zrok-frontend:
depends_on:
zrok-permissions:
condition: service_completed_successfully
build:
context: .
dockerfile: zrok-frontend.Dockerfile
args:
ZROK_CLI_IMAGE: ${ZROK_CLI_IMAGE:-openziti/zrok}
ZROK_CLI_TAG: ${ZROK_CLI_TAG:-latest}
ZROK_DNS_ZONE: ${ZROK_DNS_ZONE} # e.g., "example.com" or "127.0.0.1.sslip.io"
ZROK_FRONTEND_PORT: ${ZROK_FRONTEND_PORT:-8080}
ZROK_OAUTH_PORT: ${ZROK_OAUTH_PORT:-8081}
ZROK_OAUTH_HASH_KEY: ${ZROK_OAUTH_HASH_KEY-noop}
ZROK_OAUTH_GOOGLE_CLIENT_ID: ${ZROK_OAUTH_GOOGLE_CLIENT_ID:-noop}
ZROK_OAUTH_GOOGLE_CLIENT_SECRET: ${ZROK_OAUTH_GOOGLE_CLIENT_SECRET:-noop}
ZROK_OAUTH_GITHUB_CLIENT_ID: ${ZROK_OAUTH_GITHUB_CLIENT_ID:-noop}
ZROK_OAUTH_GITHUB_CLIENT_SECRET: ${ZROK_OAUTH_GITHUB_CLIENT_SECRET:-noop}
user: ${ZIGGY_UID:-2171}
command: zrok access public /etc/zrok-frontend/config.yml --verbose
volumes:
- zrok_frontend:/var/lib/zrok-frontend
networks:
zrok-instance:
restart: unless-stopped
expose:
- ${ZROK_FRONTEND_PORT:-8080} # (not published)
- ${ZROK_OAUTH_PORT:-8081} # (not published)
ports:
- 127.0.0.1:${ZROK_FRONTEND_PORT:-8080}:${ZROK_FRONTEND_PORT:-8080}
- 127.0.0.1:${ZROK_OAUTH_PORT:-8081}:${ZROK_OAUTH_PORT:-8081}
environment:
HOME: /var/lib/zrok-frontend
ZROK_DNS_ZONE: ${ZROK_DNS_ZONE} # e.g., "example.com" or "127.0.0.1.sslip.io"
ZROK_ADMIN_TOKEN: ${ZROK_ADMIN_TOKEN} # zrok controller admin password
ZROK_API_ENDPOINT: http://zrok-controller:${ZROK_CTRL_PORT:-18080} # bridge address of the zrok controller
ZROK_FRONTEND_SCHEME: http
ZROK_FRONTEND_PORT: ${ZROK_FRONTEND_PORT:-8080}
ZITI_CTRL_ADVERTISED_PORT: ${ZITI_CTRL_ADVERTISED_PORT:-1280}
ZITI_PWD: ${ZITI_PWD} # ziti controller admin password
volumes:
ziti_home: # this will not be used if you switch from named volume to bind mount volume
zrok_ctrl:
zrok_frontend:
# define a custom network so that we can also define DNS aliases
networks:
zrok-instance:
driver: bridge

2
zrok-private-access/.gitignore vendored Normal file
View File

@ -0,0 +1,2 @@
.env
/compose.override.yml

2
zrok-private-share/.gitignore vendored Normal file
View File

@ -0,0 +1,2 @@
.env
/compose.override.yml

0
.gitignore → zrok-public-reserved/.gitignore vendored
View File

2
zrok-public-share/.gitignore vendored Normal file
View File

@ -0,0 +1,2 @@
.env
*compose.override.yml