reworking docs, rearranging, small edits, etc

This commit is contained in:
dovholuknf 2023-01-29 14:28:30 -05:00
parent a9b6e55336
commit fce2be5731
No known key found for this signature in database
GPG Key ID: 0EE08251136D3480
30 changed files with 69 additions and 33 deletions

View File

@ -24,7 +24,7 @@ You can be up and sharing using the `zrok.io` service in minutes. Here is a syno
* `zrok share` to share resources immediately, simply and securely * `zrok share` to share resources immediately, simply and securely
See the [Concepts and Getting Started Guide](docs/v0.3_getting_started/getting_started.md) for a full overview. See the [Concepts and Getting Started Guide](docs/getting-started/v0.3_getting_started/getting_started.md) for a full overview.
## Self-Hosting ## Self-Hosting

View File

@ -46,7 +46,7 @@ This allows users to create read/write repositories of files that can be shared
The following illustration shows the possibilities available. The following illustration shows the possibilities available.
![v0.3 Frontend Selection](images/zrok_frontends_v0.3.png) ![v0.3 Frontend Selection](../images/zrok_frontends_v0.3.png)
The `*.in.zrok.io` frontend is a "public" frontend, available to all `zrok` users. Most `zrok` installations will want to have at least one public, global frontend for all public, internet-facing ingress traffic for private backend instances. In the underlying data store, the public frontend will have a `name` set to `public` (or some other representative name), allowing users to reference that `frontend` using a friendly label. The `*.in.zrok.io` frontend is a "public" frontend, available to all `zrok` users. Most `zrok` installations will want to have at least one public, global frontend for all public, internet-facing ingress traffic for private backend instances. In the underlying data store, the public frontend will have a `name` set to `public` (or some other representative name), allowing users to reference that `frontend` using a friendly label.

View File

@ -0,0 +1,9 @@
---
sidebar_position: 50
---
# Downloads
Right now all `zrok` binaries are delivered from the release page at GitHub.
Head over to https://github.com/openziti/zrok/releases/latest to find the latest downloads.

View File

@ -82,7 +82,7 @@ $ zrok proxy ~/.zrok/proxy.json
``` ```
$ zrok create account $ zrok create account
New Username: michael@quigley.com New Username: user@domain.com
New Password: New Password:
Confirm Password: Confirm Password:
[ 3.122] INFO main.glob..func1: api token: 9ae56d39a6e96d65a45518b5ea1637a0677581a33ba44bbc3c103f6351ec478fb8185e97a993382ed2daa26720d40b052824dbce5ef38874c82893f33e445b06 [ 3.122] INFO main.glob..func1: api token: 9ae56d39a6e96d65a45518b5ea1637a0677581a33ba44bbc3c103f6351ec478fb8185e97a993382ed2daa26720d40b052824dbce5ef38874c82893f33e445b06

View File

@ -124,12 +124,12 @@ $ zrok invite
enter and confirm your email address... enter and confirm your email address...
> michael.quigley@netfoundry.io > user@domain.com
> michael.quigley@netfoundry.io > user@domain.com
[ Submit ] [ Submit ]
invitation sent to 'michael.quigley@netfoundry.io'! invitation sent to 'user@domain.com'!
``` ```
The `zrok invite` command presents a small form that allows you to enter (and then confirm) your email address. Tabbing to the `[ Submit ]` button will send the request to your configured `zrok` service. The `zrok invite` command presents a small form that allows you to enter (and then confirm) your email address. Tabbing to the `[ Submit ]` button will send the request to your configured `zrok` service.
@ -366,7 +366,7 @@ You use the `zrok reserve` command to create _reserved shares_. Reserved shares
## Self-Hosting a Service Instance ## Self-Hosting a Service Instance
Interested in self-hosting your own `zrok` service instance? See the [self-hosting guide](../v0.3_self_hosting_guide.md) for details. Interested in self-hosting your own `zrok` service instance? See the [self-hosting guide](../../guides/v0.3_self_hosting_guide.md) for details.
[openziti]: https://docs.openziti.io/ "OpenZiti" [openziti]: https://docs.openziti.io/ "OpenZiti"
[ zrok-download]: https://zrok.io "Zrok Download" [ zrok-download]: https://zrok.io "Zrok Download"

View File

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 21 KiB

View File

Before

Width:  |  Height:  |  Size: 62 KiB

After

Width:  |  Height:  |  Size: 62 KiB

View File

Before

Width:  |  Height:  |  Size: 55 KiB

After

Width:  |  Height:  |  Size: 55 KiB

View File

Before

Width:  |  Height:  |  Size: 54 KiB

After

Width:  |  Height:  |  Size: 54 KiB

View File

Before

Width:  |  Height:  |  Size: 78 KiB

After

Width:  |  Height:  |  Size: 78 KiB

View File

Before

Width:  |  Height:  |  Size: 64 KiB

After

Width:  |  Height:  |  Size: 64 KiB

View File

Before

Width:  |  Height:  |  Size: 52 KiB

After

Width:  |  Height:  |  Size: 52 KiB

View File

Before

Width:  |  Height:  |  Size: 49 KiB

After

Width:  |  Height:  |  Size: 49 KiB

View File

Before

Width:  |  Height:  |  Size: 2.0 KiB

After

Width:  |  Height:  |  Size: 2.0 KiB

View File

@ -1,6 +1,6 @@
# Nginx Reverse Proxy for zrok # Nginx Reverse Proxy for zrok
I'll assume you have a running zrok controller and public frontend and wish to front both with Nginx providing server TLS. Go back to [the hosting quickstart](v0.2_quickstart.md) if you still need to spin those up. I'll assume you have a running zrok controller and public frontend and wish to front both with Nginx providing server TLS. Go back to [the hosting quickstart](../getting-started/v0.2_quickstart.md) if you still need to spin those up.
## Choose a Reverse Proxy Address ## Choose a Reverse Proxy Address

View File

@ -169,15 +169,15 @@ This process uses the `frontend` identity created during the bootstrap process t
```bash ```bash
$ zrok invite $ zrok invite
New Email: michael@quigley.com New Email: user@domain.com
Confirm Email: michael@quigley.com Confirm Email: user@domain.com
invitation sent to 'michael@quigley.com'! invitation sent to 'user@domain.com'!
``` ```
If you look at the console output from your `zrok` controller, you'll see a message like this: If you look at the console output from your `zrok` controller, you'll see a message like this:
``` ```
[ 238.168] INFO zrok/controller.(*inviteHandler).Handle: account request for 'michael@quigley.com' has registration token 'U2Ewt1UCn3ql' [ 238.168] INFO zrok/controller.(*inviteHandler).Handle: account request for 'user@domain.com' has registration token 'U2Ewt1UCn3ql'
``` ```
You can access your `zrok` controller's registration UI by pointing a web browser at: You can access your `zrok` controller's registration UI by pointing a web browser at:
@ -191,7 +191,7 @@ The UI will ask you to set a password for your new account. Go ahead and do that
After doing that, I see the following output in my controller console: After doing that, I see the following output in my controller console:
``` ```
[ 516.778] INFO zrok/controller.(*registerHandler).Handle: created account 'michael@quigley.com' with token 'SuGzRPjVDIcF' [ 516.778] INFO zrok/controller.(*registerHandler).Handle: created account 'user@domain.com' with token 'SuGzRPjVDIcF'
``` ```
Keep track of the token listed above (`SuGzRPjVDIcF`). We'll use this to enable our shell for this `zrok` deployment. Keep track of the token listed above (`SuGzRPjVDIcF`). We'll use this to enable our shell for this `zrok` deployment.

View File

@ -1,7 +0,0 @@
# Zrok
This is zrok. A globally-distributed, zero trust proxy.
## Overview
This is where you'd place overview material.

View File

@ -1,6 +1,9 @@
# zrok v0.1.x ---
sidebar_position: 0
---
# What is zrok
## What Is `zrok`? ## Overview
`zrok` is a super-lightweight tool for providing on-demand access to dark, unreachable resources. `zrok` is a super-lightweight tool for providing on-demand access to dark, unreachable resources.
The super-power of `zrok` is providing a single-step solution to creating ephemeral network connectivity. From an end-user perspective, `zrok` is a tool packaged as a single executable, which can be used as a "shim" to quickly create public endpoints for dark resources. The super-power of `zrok` is providing a single-step solution to creating ephemeral network connectivity. From an end-user perspective, `zrok` is a tool packaged as a single executable, which can be used as a "shim" to quickly create public endpoints for dark resources.

View File

@ -75,10 +75,22 @@ const config = {
items: [ items: [
{ {
type: 'doc', type: 'doc',
docId: 'index', docId: 'overview',
position: 'left', position: 'right',
label: 'What is zrok?',
},
{
type: 'doc',
docId: 'overview',
position: 'right',
label: 'Docs', label: 'Docs',
}, },
{
type: 'doc',
docId: 'overview',
position: 'right',
label: 'Downloads',
},
{ {
href: 'https://github.com/openziti/zrok', href: 'https://github.com/openziti/zrok',
label: 'GitHub', label: 'GitHub',

View File

@ -20,6 +20,10 @@
--ifm-code-font-size: 95%; --ifm-code-font-size: 95%;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1); --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
--ifm-menu-color: #252525; --ifm-menu-color: #252525;
--code-background-color: rgba(62,38,147,.1);
--code-font-color: #252525;
--selection-font-color: #0f023b;
--selection-background: #9BF316;
} }
/* For readability concerns, you should choose a lighter palette in dark mode. */ /* For readability concerns, you should choose a lighter palette in dark mode. */
@ -32,6 +36,9 @@
--ifm-color-primary-lighter: #9af90a; --ifm-color-primary-lighter: #9af90a;
--ifm-color-primary-lightest: #99ff00; --ifm-color-primary-lightest: #99ff00;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3); --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
--code-background-color: rgba(76, 55, 123, 0.53);
--code-font-color: rgb(167, 130, 217);
--selection-color: #0f023b;
} }
@media (min-width: 1416px) { @media (min-width: 1416px) {
@ -56,7 +63,7 @@
--ifm-navbar-background-color: #0d0235; --ifm-navbar-background-color: #0d0235;
--ifm-background-color: unset; --ifm-background-color: unset;
--ifm-link-color: #9bf316; --ifm-link-color: #9bf316;
--ifm-menu-color: #ffffff; --ifm-menu-color: #FFFFFFD4;
} }
@ -66,7 +73,7 @@
[data-theme='dark'] [data-theme='dark']
#__docusaurus { #__docusaurus {
background: linear-gradient(180deg, rgba(14,2,56,1) 0%, rgba(35,16,105,1) 100%); background: linear-gradient(180deg, rgba(20,12,66,1) 0%, rgba(35,16,105,1) 100%);
} }
.menu__link--active:not(.menu__link--sublist) { .menu__link--active:not(.menu__link--sublist) {
@ -99,7 +106,7 @@ html {
[data-theme='dark'] [data-theme='dark']
.menu__link { .menu__link {
color: #ffffff; color: #FFFFFFD4;
} }
.navbar__link:hover, .navbar__link--active { .navbar__link:hover, .navbar__link--active {
@ -116,10 +123,13 @@ code {
font-weight: 800; font-weight: 800;
white-space: break-spaces; white-space: break-spaces;
background-color: #f2f2f2; background-color: #f2f2f2;
color: #ff0048; color2: rgb(167, 130, 217);
color: var(--code-font-color);
border-radius: 6px; border-radius: 6px;
border-width: 0px; border-width: 0px;
border-color: rgba(240, 240, 240, 1); border-color: var(--code-background-color);
background-color2: rgba(76, 55, 123, 0.53);
background-color: var(--code-background-color);
} }
[data-theme='dark'] [data-theme='dark']
@ -134,7 +144,7 @@ h3,
h4, h4,
h5, h5,
h6 { h6 {
color: #ffffff; color: var(--ifm-heading-color);
} }
[data-theme='dark'] [data-theme='dark']
@ -147,5 +157,14 @@ h6 {
} }
a code { a code {
color: #ff0048; color: rgb(167, 130, 217);
}
::-moz-selection { /* Code for Firefox */
color: var(--selection-font-color);
background: var(--selection-background);
}
::selection {
color: var(--selection-font-color);
background: var(--selection-background);
} }