mirror of
https://github.com/openziti/zrok.git
synced 2025-03-31 01:26:12 +02:00
more updates
This commit is contained in:
parent
8432797fa3
commit
50b592b4c3
README.md
docs
cli-usage
zrok.mdzrok_access.mdzrok_access_private.mdzrok_access_public.mdzrok_admin.mdzrok_admin_bootstrap.mdzrok_admin_create.mdzrok_admin_create_frontend.mdzrok_admin_create_identity.mdzrok_admin_delete.mdzrok_admin_delete_frontend.mdzrok_admin_gc.mdzrok_admin_generate.mdzrok_admin_list.mdzrok_admin_list_frontends.mdzrok_admin_update.mdzrok_admin_update_frontend.mdzrok_completion.mdzrok_completion_bash.mdzrok_completion_fish.mdzrok_completion_powershell.mdzrok_completion_zsh.mdzrok_config.mdzrok_config_get.mdzrok_config_set.mdzrok_config_unset.mdzrok_controller.mdzrok_disable.mdzrok_enable.mdzrok_genmd.mdzrok_invite.mdzrok_release.mdzrok_reserve.mdzrok_share.mdzrok_share_private.mdzrok_share_public.mdzrok_share_reserved.mdzrok_status.mdzrok_test.mdzrok_test_endpoint.mdzrok_test_loop.mdzrok_version.md
core-features
getting-started.mdwebsite
@ -1,6 +1,6 @@
|
|||||||

|

|
||||||
|
|
||||||
`zrok` is a next-generation sharing platform built on top of [OpenZiti](https://docs.openziti.io), a programmable zero-trust network overlay. `zrok` is an OpenZiti _Native Application_.
|
`zrok` is a next-generation sharing platform built on top of [OpenZiti](https://docs.openziti.io/docs/learn/introduction/), a programmable zero-trust network overlay. `zrok` is an OpenZiti _Native Application_.
|
||||||
|
|
||||||
`zrok` facilitates sharing resources both publicly and privately, exposing them to an audience you can easily control.
|
`zrok` facilitates sharing resources both publicly and privately, exposing them to an audience you can easily control.
|
||||||
|
|
||||||
|
31
docs/cli-usage/zrok.md
Normal file
31
docs/cli-usage/zrok.md
Normal file
@ -0,0 +1,31 @@
|
|||||||
|
## zrok
|
||||||
|
|
||||||
|
zrok
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for zrok
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok access](zrok_access.md) - Create frontend access for shares
|
||||||
|
* [zrok admin](zrok_admin.md) - Administration and operations functions
|
||||||
|
* [zrok completion](zrok_completion.md) - Generate the autocompletion script for the specified shell
|
||||||
|
* [zrok config](zrok_config.md) - Configure your zrok environment
|
||||||
|
* [zrok controller](zrok_controller.md) - Start a zrok controller
|
||||||
|
* [zrok disable](zrok_disable.md) - Disable (and clean up) the enabled zrok environment
|
||||||
|
* [zrok enable](zrok_enable.md) - Enable an environment for zrok
|
||||||
|
* [zrok genmd](zrok_genmd.md) - generates markdown from the cobra code
|
||||||
|
* [zrok invite](zrok_invite.md) - Invite a new user to zrok
|
||||||
|
* [zrok release](zrok_release.md) - Release a reserved share
|
||||||
|
* [zrok reserve](zrok_reserve.md) - Create a reserved share
|
||||||
|
* [zrok share](zrok_share.md) - Create backend access for shares
|
||||||
|
* [zrok status](zrok_status.md) - Show the current environment status
|
||||||
|
* [zrok test](zrok_test.md) - Utilities for testing zrok deployments
|
||||||
|
* [zrok version](zrok_version.md) -
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
24
docs/cli-usage/zrok_access.md
Normal file
24
docs/cli-usage/zrok_access.md
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
## zrok access
|
||||||
|
|
||||||
|
Create frontend access for shares
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for access
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok](zrok.md) - zrok
|
||||||
|
* [zrok access private](zrok_access_private.md) - Create a private frontend to access a share
|
||||||
|
* [zrok access public](zrok_access_public.md) - Create a public access HTTP frontend
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
27
docs/cli-usage/zrok_access_private.md
Normal file
27
docs/cli-usage/zrok_access_private.md
Normal file
@ -0,0 +1,27 @@
|
|||||||
|
## zrok access private
|
||||||
|
|
||||||
|
Create a private frontend to access a share
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok access private <shareToken> [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-b, --bind string The address to bind the private frontend (default "127.0.0.1:9191")
|
||||||
|
-h, --help help for private
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok access](zrok_access.md) - Create frontend access for shares
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
26
docs/cli-usage/zrok_access_public.md
Normal file
26
docs/cli-usage/zrok_access_public.md
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
## zrok access public
|
||||||
|
|
||||||
|
Create a public access HTTP frontend
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok access public [<configPath>] [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for public
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok access](zrok_access.md) - Create frontend access for shares
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
29
docs/cli-usage/zrok_admin.md
Normal file
29
docs/cli-usage/zrok_admin.md
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
## zrok admin
|
||||||
|
|
||||||
|
Administration and operations functions
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for admin
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok](zrok.md) - zrok
|
||||||
|
* [zrok admin bootstrap](zrok_admin_bootstrap.md) - Bootstrap the underlying Ziti network for zrok
|
||||||
|
* [zrok admin create](zrok_admin_create.md) - Create global resources
|
||||||
|
* [zrok admin delete](zrok_admin_delete.md) - Delete global resources
|
||||||
|
* [zrok admin gc](zrok_admin_gc.md) - Garbage collect a zrok instance
|
||||||
|
* [zrok admin generate](zrok_admin_generate.md) - Generate invite tokens
|
||||||
|
* [zrok admin list](zrok_admin_list.md) - List global resources
|
||||||
|
* [zrok admin update](zrok_admin_update.md) - Update global resources
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
28
docs/cli-usage/zrok_admin_bootstrap.md
Normal file
28
docs/cli-usage/zrok_admin_bootstrap.md
Normal file
@ -0,0 +1,28 @@
|
|||||||
|
## zrok admin bootstrap
|
||||||
|
|
||||||
|
Bootstrap the underlying Ziti network for zrok
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok admin bootstrap <configPath> [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for bootstrap
|
||||||
|
--skip-ctrl Skip controller (ctrl) identity bootstrapping
|
||||||
|
--skip-frontend Slip frontend identity bootstrapping
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok admin](zrok_admin.md) - Administration and operations functions
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
24
docs/cli-usage/zrok_admin_create.md
Normal file
24
docs/cli-usage/zrok_admin_create.md
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
## zrok admin create
|
||||||
|
|
||||||
|
Create global resources
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for create
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok admin](zrok_admin.md) - Administration and operations functions
|
||||||
|
* [zrok admin create frontend](zrok_admin_create_frontend.md) - Create a global public frontend
|
||||||
|
* [zrok admin create identity](zrok_admin_create_identity.md) - Create an identity and policies for a public frontend
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
26
docs/cli-usage/zrok_admin_create_frontend.md
Normal file
26
docs/cli-usage/zrok_admin_create_frontend.md
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
## zrok admin create frontend
|
||||||
|
|
||||||
|
Create a global public frontend
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok admin create frontend <zitiId> <publicName> <urlTemplate> [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for frontend
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok admin create](zrok_admin_create.md) - Create global resources
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
26
docs/cli-usage/zrok_admin_create_identity.md
Normal file
26
docs/cli-usage/zrok_admin_create_identity.md
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
## zrok admin create identity
|
||||||
|
|
||||||
|
Create an identity and policies for a public frontend
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok admin create identity <name> [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for identity
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok admin create](zrok_admin_create.md) - Create global resources
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
23
docs/cli-usage/zrok_admin_delete.md
Normal file
23
docs/cli-usage/zrok_admin_delete.md
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
## zrok admin delete
|
||||||
|
|
||||||
|
Delete global resources
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for delete
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok admin](zrok_admin.md) - Administration and operations functions
|
||||||
|
* [zrok admin delete frontend](zrok_admin_delete_frontend.md) - Delete a global public frontend
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
26
docs/cli-usage/zrok_admin_delete_frontend.md
Normal file
26
docs/cli-usage/zrok_admin_delete_frontend.md
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
## zrok admin delete frontend
|
||||||
|
|
||||||
|
Delete a global public frontend
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok admin delete frontend <frontendToken> [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for frontend
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok admin delete](zrok_admin_delete.md) - Delete global resources
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
26
docs/cli-usage/zrok_admin_gc.md
Normal file
26
docs/cli-usage/zrok_admin_gc.md
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
## zrok admin gc
|
||||||
|
|
||||||
|
Garbage collect a zrok instance
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok admin gc <configPath> [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for gc
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok admin](zrok_admin.md) - Administration and operations functions
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
27
docs/cli-usage/zrok_admin_generate.md
Normal file
27
docs/cli-usage/zrok_admin_generate.md
Normal file
@ -0,0 +1,27 @@
|
|||||||
|
## zrok admin generate
|
||||||
|
|
||||||
|
Generate invite tokens
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok admin generate [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-n, --count int Number of tokens to generate (default 5)
|
||||||
|
-h, --help help for generate
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok admin](zrok_admin.md) - Administration and operations functions
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
23
docs/cli-usage/zrok_admin_list.md
Normal file
23
docs/cli-usage/zrok_admin_list.md
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
## zrok admin list
|
||||||
|
|
||||||
|
List global resources
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for list
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok admin](zrok_admin.md) - Administration and operations functions
|
||||||
|
* [zrok admin list frontends](zrok_admin_list_frontends.md) - List global public frontends
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
26
docs/cli-usage/zrok_admin_list_frontends.md
Normal file
26
docs/cli-usage/zrok_admin_list_frontends.md
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
## zrok admin list frontends
|
||||||
|
|
||||||
|
List global public frontends
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok admin list frontends [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for frontends
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok admin list](zrok_admin_list.md) - List global resources
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
23
docs/cli-usage/zrok_admin_update.md
Normal file
23
docs/cli-usage/zrok_admin_update.md
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
## zrok admin update
|
||||||
|
|
||||||
|
Update global resources
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for update
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok admin](zrok_admin.md) - Administration and operations functions
|
||||||
|
* [zrok admin update frontend](zrok_admin_update_frontend.md) - Update a global public frontend
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
28
docs/cli-usage/zrok_admin_update_frontend.md
Normal file
28
docs/cli-usage/zrok_admin_update_frontend.md
Normal file
@ -0,0 +1,28 @@
|
|||||||
|
## zrok admin update frontend
|
||||||
|
|
||||||
|
Update a global public frontend
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok admin update frontend <frontendToken> [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for frontend
|
||||||
|
--public-name string Specify a new value for the public name
|
||||||
|
--url-template string Specify a new value for the url template
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok admin update](zrok_admin_update.md) - Update global resources
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
32
docs/cli-usage/zrok_completion.md
Normal file
32
docs/cli-usage/zrok_completion.md
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
## zrok completion
|
||||||
|
|
||||||
|
Generate the autocompletion script for the specified shell
|
||||||
|
|
||||||
|
### Synopsis
|
||||||
|
|
||||||
|
Generate the autocompletion script for zrok for the specified shell.
|
||||||
|
See each sub-command's help for details on how to use the generated script.
|
||||||
|
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for completion
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok](zrok.md) - zrok
|
||||||
|
* [zrok completion bash](zrok_completion_bash.md) - Generate the autocompletion script for bash
|
||||||
|
* [zrok completion fish](zrok_completion_fish.md) - Generate the autocompletion script for fish
|
||||||
|
* [zrok completion powershell](zrok_completion_powershell.md) - Generate the autocompletion script for powershell
|
||||||
|
* [zrok completion zsh](zrok_completion_zsh.md) - Generate the autocompletion script for zsh
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
51
docs/cli-usage/zrok_completion_bash.md
Normal file
51
docs/cli-usage/zrok_completion_bash.md
Normal file
@ -0,0 +1,51 @@
|
|||||||
|
## zrok completion bash
|
||||||
|
|
||||||
|
Generate the autocompletion script for bash
|
||||||
|
|
||||||
|
### Synopsis
|
||||||
|
|
||||||
|
Generate the autocompletion script for the bash shell.
|
||||||
|
|
||||||
|
This script depends on the 'bash-completion' package.
|
||||||
|
If it is not installed already, you can install it via your OS's package manager.
|
||||||
|
|
||||||
|
To load completions in your current shell session:
|
||||||
|
|
||||||
|
source <(zrok completion bash)
|
||||||
|
|
||||||
|
To load completions for every new session, execute once:
|
||||||
|
|
||||||
|
#### Linux:
|
||||||
|
|
||||||
|
zrok completion bash > /etc/bash_completion.d/zrok
|
||||||
|
|
||||||
|
#### macOS:
|
||||||
|
|
||||||
|
zrok completion bash > $(brew --prefix)/etc/bash_completion.d/zrok
|
||||||
|
|
||||||
|
You will need to start a new shell for this setup to take effect.
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok completion bash
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for bash
|
||||||
|
--no-descriptions disable completion descriptions
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok completion](zrok_completion.md) - Generate the autocompletion script for the specified shell
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
42
docs/cli-usage/zrok_completion_fish.md
Normal file
42
docs/cli-usage/zrok_completion_fish.md
Normal file
@ -0,0 +1,42 @@
|
|||||||
|
## zrok completion fish
|
||||||
|
|
||||||
|
Generate the autocompletion script for fish
|
||||||
|
|
||||||
|
### Synopsis
|
||||||
|
|
||||||
|
Generate the autocompletion script for the fish shell.
|
||||||
|
|
||||||
|
To load completions in your current shell session:
|
||||||
|
|
||||||
|
zrok completion fish | source
|
||||||
|
|
||||||
|
To load completions for every new session, execute once:
|
||||||
|
|
||||||
|
zrok completion fish > ~/.config/fish/completions/zrok.fish
|
||||||
|
|
||||||
|
You will need to start a new shell for this setup to take effect.
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok completion fish [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for fish
|
||||||
|
--no-descriptions disable completion descriptions
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok completion](zrok_completion.md) - Generate the autocompletion script for the specified shell
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
39
docs/cli-usage/zrok_completion_powershell.md
Normal file
39
docs/cli-usage/zrok_completion_powershell.md
Normal file
@ -0,0 +1,39 @@
|
|||||||
|
## zrok completion powershell
|
||||||
|
|
||||||
|
Generate the autocompletion script for powershell
|
||||||
|
|
||||||
|
### Synopsis
|
||||||
|
|
||||||
|
Generate the autocompletion script for powershell.
|
||||||
|
|
||||||
|
To load completions in your current shell session:
|
||||||
|
|
||||||
|
zrok completion powershell | Out-String | Invoke-Expression
|
||||||
|
|
||||||
|
To load completions for every new session, add the output of the above command
|
||||||
|
to your powershell profile.
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok completion powershell [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for powershell
|
||||||
|
--no-descriptions disable completion descriptions
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok completion](zrok_completion.md) - Generate the autocompletion script for the specified shell
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
53
docs/cli-usage/zrok_completion_zsh.md
Normal file
53
docs/cli-usage/zrok_completion_zsh.md
Normal file
@ -0,0 +1,53 @@
|
|||||||
|
## zrok completion zsh
|
||||||
|
|
||||||
|
Generate the autocompletion script for zsh
|
||||||
|
|
||||||
|
### Synopsis
|
||||||
|
|
||||||
|
Generate the autocompletion script for the zsh shell.
|
||||||
|
|
||||||
|
If shell completion is not already enabled in your environment you will need
|
||||||
|
to enable it. You can execute the following once:
|
||||||
|
|
||||||
|
echo "autoload -U compinit; compinit" >> ~/.zshrc
|
||||||
|
|
||||||
|
To load completions in your current shell session:
|
||||||
|
|
||||||
|
source <(zrok completion zsh); compdef _zrok zrok
|
||||||
|
|
||||||
|
To load completions for every new session, execute once:
|
||||||
|
|
||||||
|
#### Linux:
|
||||||
|
|
||||||
|
zrok completion zsh > "${fpath[1]}/_zrok"
|
||||||
|
|
||||||
|
#### macOS:
|
||||||
|
|
||||||
|
zrok completion zsh > $(brew --prefix)/share/zsh/site-functions/_zrok
|
||||||
|
|
||||||
|
You will need to start a new shell for this setup to take effect.
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok completion zsh [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for zsh
|
||||||
|
--no-descriptions disable completion descriptions
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok completion](zrok_completion.md) - Generate the autocompletion script for the specified shell
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
25
docs/cli-usage/zrok_config.md
Normal file
25
docs/cli-usage/zrok_config.md
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
## zrok config
|
||||||
|
|
||||||
|
Configure your zrok environment
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for config
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok](zrok.md) - zrok
|
||||||
|
* [zrok config get](zrok_config_get.md) - Get a value from the environment config
|
||||||
|
* [zrok config set](zrok_config_set.md) - Set a value into the environment config
|
||||||
|
* [zrok config unset](zrok_config_unset.md) - Unset a value from the environment config
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
26
docs/cli-usage/zrok_config_get.md
Normal file
26
docs/cli-usage/zrok_config_get.md
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
## zrok config get
|
||||||
|
|
||||||
|
Get a value from the environment config
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok config get <configName> [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for get
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok config](zrok_config.md) - Configure your zrok environment
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
26
docs/cli-usage/zrok_config_set.md
Normal file
26
docs/cli-usage/zrok_config_set.md
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
## zrok config set
|
||||||
|
|
||||||
|
Set a value into the environment config
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok config set <configName> <value> [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for set
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok config](zrok_config.md) - Configure your zrok environment
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
26
docs/cli-usage/zrok_config_unset.md
Normal file
26
docs/cli-usage/zrok_config_unset.md
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
## zrok config unset
|
||||||
|
|
||||||
|
Unset a value from the environment config
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok config unset <configName> [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for unset
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok config](zrok_config.md) - Configure your zrok environment
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
26
docs/cli-usage/zrok_controller.md
Normal file
26
docs/cli-usage/zrok_controller.md
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
## zrok controller
|
||||||
|
|
||||||
|
Start a zrok controller
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok controller <configPath> [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for controller
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok](zrok.md) - zrok
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
26
docs/cli-usage/zrok_disable.md
Normal file
26
docs/cli-usage/zrok_disable.md
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
## zrok disable
|
||||||
|
|
||||||
|
Disable (and clean up) the enabled zrok environment
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok disable [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for disable
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok](zrok.md) - zrok
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
27
docs/cli-usage/zrok_enable.md
Normal file
27
docs/cli-usage/zrok_enable.md
Normal file
@ -0,0 +1,27 @@
|
|||||||
|
## zrok enable
|
||||||
|
|
||||||
|
Enable an environment for zrok
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok enable <token> [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-d, --description string Description of this environment (default "<user>@<hostname>")
|
||||||
|
-h, --help help for enable
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok](zrok.md) - zrok
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
26
docs/cli-usage/zrok_genmd.md
Normal file
26
docs/cli-usage/zrok_genmd.md
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
## zrok genmd
|
||||||
|
|
||||||
|
generates markdown from the cobra code
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok genmd [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for genmd
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok](zrok.md) - zrok
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
27
docs/cli-usage/zrok_invite.md
Normal file
27
docs/cli-usage/zrok_invite.md
Normal file
@ -0,0 +1,27 @@
|
|||||||
|
## zrok invite
|
||||||
|
|
||||||
|
Invite a new user to zrok
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok invite [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for invite
|
||||||
|
--token string Invite token required when zrok running in token store mode
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok](zrok.md) - zrok
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
26
docs/cli-usage/zrok_release.md
Normal file
26
docs/cli-usage/zrok_release.md
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
## zrok release
|
||||||
|
|
||||||
|
Release a reserved share
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok release <shareToken> [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for release
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok](zrok.md) - zrok
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
29
docs/cli-usage/zrok_reserve.md
Normal file
29
docs/cli-usage/zrok_reserve.md
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
## zrok reserve
|
||||||
|
|
||||||
|
Create a reserved share
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok reserve <public|private> <target> [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
--backend-mode string The backend mode {proxy, web} (default "proxy")
|
||||||
|
--basic-auth stringArray Basic authentication users (<username:password>,...)
|
||||||
|
--frontends stringArray Selected frontends to use for the share (default [public])
|
||||||
|
-h, --help help for reserve
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok](zrok.md) - zrok
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
25
docs/cli-usage/zrok_share.md
Normal file
25
docs/cli-usage/zrok_share.md
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
## zrok share
|
||||||
|
|
||||||
|
Create backend access for shares
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for share
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok](zrok.md) - zrok
|
||||||
|
* [zrok share private](zrok_share_private.md) - Share a target resource privately
|
||||||
|
* [zrok share public](zrok_share_public.md) - Share a target resource publicly
|
||||||
|
* [zrok share reserved](zrok_share_reserved.md) - Start a backend for a reserved share
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
30
docs/cli-usage/zrok_share_private.md
Normal file
30
docs/cli-usage/zrok_share_private.md
Normal file
@ -0,0 +1,30 @@
|
|||||||
|
## zrok share private
|
||||||
|
|
||||||
|
Share a target resource privately
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok share private <target> [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
--backend-mode string The backend mode {proxy, web} (default "proxy")
|
||||||
|
--basic-auth stringArray Basic authentication users (<username:password>,...
|
||||||
|
--headless Disable TUI and run headless
|
||||||
|
-h, --help help for private
|
||||||
|
--insecure Enable insecure TLS certificate validation for <target>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok share](zrok_share.md) - Create backend access for shares
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
31
docs/cli-usage/zrok_share_public.md
Normal file
31
docs/cli-usage/zrok_share_public.md
Normal file
@ -0,0 +1,31 @@
|
|||||||
|
## zrok share public
|
||||||
|
|
||||||
|
Share a target resource publicly
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok share public <target> [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
--backend-mode string The backend mode {proxy, web} (default "proxy")
|
||||||
|
--basic-auth stringArray Basic authentication users (<username:password>,...)
|
||||||
|
--frontends stringArray Selected frontends to use for the share (default [public])
|
||||||
|
--headless Disable TUI and run headless
|
||||||
|
-h, --help help for public
|
||||||
|
--insecure Enable insecure TLS certificate validation for <target>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok share](zrok_share.md) - Create backend access for shares
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
29
docs/cli-usage/zrok_share_reserved.md
Normal file
29
docs/cli-usage/zrok_share_reserved.md
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
## zrok share reserved
|
||||||
|
|
||||||
|
Start a backend for a reserved share
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok share reserved <shareToken> [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
--headless Disable TUI and run headless
|
||||||
|
-h, --help help for reserved
|
||||||
|
--insecure Enable insecure TLS certificate validation
|
||||||
|
--override-endpoint string Override the stored target endpoint with a replacement
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok share](zrok_share.md) - Create backend access for shares
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
26
docs/cli-usage/zrok_status.md
Normal file
26
docs/cli-usage/zrok_status.md
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
## zrok status
|
||||||
|
|
||||||
|
Show the current environment status
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok status [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for status
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok](zrok.md) - zrok
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
24
docs/cli-usage/zrok_test.md
Normal file
24
docs/cli-usage/zrok_test.md
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
## zrok test
|
||||||
|
|
||||||
|
Utilities for testing zrok deployments
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for test
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok](zrok.md) - zrok
|
||||||
|
* [zrok test endpoint](zrok_test_endpoint.md) - Start a simple HTTP endpoint
|
||||||
|
* [zrok test loop](zrok_test_loop.md) - Start a loop agent
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
28
docs/cli-usage/zrok_test_endpoint.md
Normal file
28
docs/cli-usage/zrok_test_endpoint.md
Normal file
@ -0,0 +1,28 @@
|
|||||||
|
## zrok test endpoint
|
||||||
|
|
||||||
|
Start a simple HTTP endpoint
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok test endpoint [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-a, --address string The address for the HTTP listener (default "127.0.0.1")
|
||||||
|
-h, --help help for endpoint
|
||||||
|
-P, --port uint16 The port for the HTTP listener (default 9090)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok test](zrok_test.md) - Utilities for testing zrok deployments
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
37
docs/cli-usage/zrok_test_loop.md
Normal file
37
docs/cli-usage/zrok_test_loop.md
Normal file
@ -0,0 +1,37 @@
|
|||||||
|
## zrok test loop
|
||||||
|
|
||||||
|
Start a loop agent
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok test loop [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
--frontends stringArray Selected frontends to use for the share (default [public])
|
||||||
|
-h, --help help for loop
|
||||||
|
-i, --iterations int Number of iterations per looper (default 1)
|
||||||
|
-l, --loopers int Number of current loopers to start (default 1)
|
||||||
|
--max-dwell-ms int Maximum dwell time in milliseconds (default 1000)
|
||||||
|
--max-pacing-ms int Maximum pacing in milliseconds
|
||||||
|
--max-payload int Maximum payload size in bytes (default 10240)
|
||||||
|
--min-dwell-ms int Minimum dwell time in milliseconds (default 1000)
|
||||||
|
--min-pacing-ms int Minimum pacing in milliseconds
|
||||||
|
--min-payload int Minimum payload size in bytes (default 64)
|
||||||
|
-E, --status-every int Show status every # iterations (default 100)
|
||||||
|
-T, --timeout-seconds int Time out after # seconds when sending http requests (default 30)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok test](zrok_test.md) - Utilities for testing zrok deployments
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
26
docs/cli-usage/zrok_version.md
Normal file
26
docs/cli-usage/zrok_version.md
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
## zrok version
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
zrok version [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
```
|
||||||
|
-h, --help help for version
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options inherited from parent commands
|
||||||
|
|
||||||
|
```
|
||||||
|
-p, --panic Panic instead of showing pretty errors
|
||||||
|
-v, --verbose Enable verbose logging
|
||||||
|
```
|
||||||
|
|
||||||
|
### SEE ALSO
|
||||||
|
|
||||||
|
* [zrok](zrok.md) - zrok
|
||||||
|
|
||||||
|
###### Auto generated by spf13/cobra on 1-Feb-2023
|
@ -22,5 +22,5 @@ project named OpenZiti.
|
|||||||
OpenZiti is a secure overlay network focusing on bringing zero trust to applications. It is the __backbone__ of `zrok`.
|
OpenZiti is a secure overlay network focusing on bringing zero trust to applications. It is the __backbone__ of `zrok`.
|
||||||
In fact, `zrok` proudly proclaims itself as an OpenZiti _native_ application.
|
In fact, `zrok` proudly proclaims itself as an OpenZiti _native_ application.
|
||||||
|
|
||||||
If you are interested in learning more about OpenZiti head over to https://openziti.io, read the docs, try the
|
If you are interested in learning more about OpenZiti head over to [the docs](https://docs.openziti.io/docs/learn/introduction/),
|
||||||
quickstart, and don't forget to star that project too. We couldn't build `zrok` without OpenZiti!
|
try the quickstart, and don't forget to star that project too. We couldn't build `zrok` without OpenZiti!
|
@ -18,8 +18,8 @@ Sharing something with `private` is similar to sharing something publicly. The m
|
|||||||
obvious, the shared resource is `private` and the share is __not__ open to the public. With `zrok`, you
|
obvious, the shared resource is `private` and the share is __not__ open to the public. With `zrok`, you
|
||||||
can share resources on a private network without needing to expose the service to the internet. The share is not
|
can share resources on a private network without needing to expose the service to the internet. The share is not
|
||||||
through an obfuscated, difficult to guess url. Instead the sharing is accomplished using a secure, zero trust overlay
|
through an obfuscated, difficult to guess url. Instead the sharing is accomplished using a secure, zero trust overlay
|
||||||
network provided by [OpenZiti](https://openziti.io). With this private, peer to peer sharing model, there will
|
network provided by [OpenZiti](https://docs.openziti.io/docs/learn/introduction/). With this private, peer to peer
|
||||||
never an attack surface available to the open internet.
|
sharing model, there will never an attack surface available to the open internet.
|
||||||
|
|
||||||
The shared resource can be a development web server to share with friends and colleagues or perhaps,
|
The shared resource can be a development web server to share with friends and colleagues or perhaps,
|
||||||
it could be a webhook from a server running in the cloud which has `zrok` running and has been instructed
|
it could be a webhook from a server running in the cloud which has `zrok` running and has been instructed
|
||||||
|
@ -3,7 +3,18 @@ sidebar_position: 0
|
|||||||
---
|
---
|
||||||
# Getting Started with zrok
|
# Getting Started with zrok
|
||||||
|
|
||||||
`zrok` is a next-generation sharing platform built on top of [OpenZiti](https://github.com/openziti/ziti/stargazers), a programmable zero trust network overlay. `zrok` is an _OpenZiti Native Application_.
|
:::note `zrok` moves fast!
|
||||||
|
|
||||||
|
`zrok` is currently in a closed-beta phase and requires an invitation token. If you would like to try `zrok` and provide
|
||||||
|
feedback, please send an email to help@openziti.org. `zrok` is an open source project and is in its early development
|
||||||
|
phases. We're doing our development publicly. See the [roadmap](https://github.com/orgs/openziti/projects/16) for details
|
||||||
|
about the project. We are highly interested in feedback as we continue to iterate quickly. Please provide feedback in
|
||||||
|
[Discourse](https://openziti.discourse.group/), raise [GitHub Issues](https://github.com/openziti/zrok/issues), or reach
|
||||||
|
out directly.
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
`zrok` is a next-generation sharing platform built on top of [OpenZiti](https://docs.openziti.io/docs/learn/introduction/), a programmable zero trust network overlay. `zrok` is an _OpenZiti Native Application_.
|
||||||
|
|
||||||
`zrok` facilitates sharing resources publicly and privately with an audience of your choosing.
|
`zrok` facilitates sharing resources publicly and privately with an audience of your choosing.
|
||||||
|
|
||||||
@ -418,5 +429,5 @@ You use the `zrok reserve` command to create _reserved shares_. Reserved shares
|
|||||||
|
|
||||||
Interested in self-hosting your own `zrok` service instance? See the [self-hosting guide](guides/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/docs/learn/introduction/ "OpenZiti"
|
||||||
[ zrok-download]: https://zrok.io "Zrok Download"
|
[ zrok-download]: https://zrok.io "Zrok Download"
|
||||||
|
@ -78,6 +78,11 @@ const config = {
|
|||||||
position: 'right',
|
position: 'right',
|
||||||
label: 'What is zrok?',
|
label: 'What is zrok?',
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
href: 'https://github.com/orgs/openziti/projects/16',
|
||||||
|
label: 'Roadmap',
|
||||||
|
position: 'right',
|
||||||
|
},
|
||||||
{
|
{
|
||||||
type: 'doc',
|
type: 'doc',
|
||||||
docId: 'getting-started',
|
docId: 'getting-started',
|
||||||
|
@ -169,4 +169,12 @@ a code {
|
|||||||
::selection {
|
::selection {
|
||||||
color: var(--selection-font-color);
|
color: var(--selection-font-color);
|
||||||
background: var(--selection-background);
|
background: var(--selection-background);
|
||||||
|
}
|
||||||
|
|
||||||
|
.navbar__link:hover, .navbar__link--active {
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
.navbar__link {
|
||||||
|
color: var(--ifm-navbar-link-color);
|
||||||
|
font-weight: var(--ifm-font-weight-semibold);
|
||||||
}
|
}
|
Loading…
Reference in New Issue
Block a user