From 50b592b4c34bae1f1693d36d20a484d35656da49 Mon Sep 17 00:00:00 2001 From: dovholuknf <46322585+dovholuknf@users.noreply.github.com> Date: Thu, 2 Feb 2023 19:41:08 -0500 Subject: [PATCH] more updates --- README.md | 2 +- docs/cli-usage/zrok.md | 31 ++++++++++++ docs/cli-usage/zrok_access.md | 24 +++++++++ docs/cli-usage/zrok_access_private.md | 27 ++++++++++ docs/cli-usage/zrok_access_public.md | 26 ++++++++++ docs/cli-usage/zrok_admin.md | 29 +++++++++++ docs/cli-usage/zrok_admin_bootstrap.md | 28 +++++++++++ docs/cli-usage/zrok_admin_create.md | 24 +++++++++ docs/cli-usage/zrok_admin_create_frontend.md | 26 ++++++++++ docs/cli-usage/zrok_admin_create_identity.md | 26 ++++++++++ docs/cli-usage/zrok_admin_delete.md | 23 +++++++++ docs/cli-usage/zrok_admin_delete_frontend.md | 26 ++++++++++ docs/cli-usage/zrok_admin_gc.md | 26 ++++++++++ docs/cli-usage/zrok_admin_generate.md | 27 ++++++++++ docs/cli-usage/zrok_admin_list.md | 23 +++++++++ docs/cli-usage/zrok_admin_list_frontends.md | 26 ++++++++++ docs/cli-usage/zrok_admin_update.md | 23 +++++++++ docs/cli-usage/zrok_admin_update_frontend.md | 28 +++++++++++ docs/cli-usage/zrok_completion.md | 32 ++++++++++++ docs/cli-usage/zrok_completion_bash.md | 51 +++++++++++++++++++ docs/cli-usage/zrok_completion_fish.md | 42 ++++++++++++++++ docs/cli-usage/zrok_completion_powershell.md | 39 ++++++++++++++ docs/cli-usage/zrok_completion_zsh.md | 53 ++++++++++++++++++++ docs/cli-usage/zrok_config.md | 25 +++++++++ docs/cli-usage/zrok_config_get.md | 26 ++++++++++ docs/cli-usage/zrok_config_set.md | 26 ++++++++++ docs/cli-usage/zrok_config_unset.md | 26 ++++++++++ docs/cli-usage/zrok_controller.md | 26 ++++++++++ docs/cli-usage/zrok_disable.md | 26 ++++++++++ docs/cli-usage/zrok_enable.md | 27 ++++++++++ docs/cli-usage/zrok_genmd.md | 26 ++++++++++ docs/cli-usage/zrok_invite.md | 27 ++++++++++ docs/cli-usage/zrok_release.md | 26 ++++++++++ docs/cli-usage/zrok_reserve.md | 29 +++++++++++ docs/cli-usage/zrok_share.md | 25 +++++++++ docs/cli-usage/zrok_share_private.md | 30 +++++++++++ docs/cli-usage/zrok_share_public.md | 31 ++++++++++++ docs/cli-usage/zrok_share_reserved.md | 29 +++++++++++ docs/cli-usage/zrok_status.md | 26 ++++++++++ docs/cli-usage/zrok_test.md | 24 +++++++++ docs/cli-usage/zrok_test_endpoint.md | 28 +++++++++++ docs/cli-usage/zrok_test_loop.md | 37 ++++++++++++++ docs/cli-usage/zrok_version.md | 26 ++++++++++ docs/core-features/opensource.md | 4 +- docs/core-features/sharing-private.md | 4 +- docs/getting-started.md | 15 +++++- website/docusaurus.config.js | 5 ++ website/src/css/custom.css | 8 +++ 48 files changed, 1237 insertions(+), 7 deletions(-) create mode 100644 docs/cli-usage/zrok.md create mode 100644 docs/cli-usage/zrok_access.md create mode 100644 docs/cli-usage/zrok_access_private.md create mode 100644 docs/cli-usage/zrok_access_public.md create mode 100644 docs/cli-usage/zrok_admin.md create mode 100644 docs/cli-usage/zrok_admin_bootstrap.md create mode 100644 docs/cli-usage/zrok_admin_create.md create mode 100644 docs/cli-usage/zrok_admin_create_frontend.md create mode 100644 docs/cli-usage/zrok_admin_create_identity.md create mode 100644 docs/cli-usage/zrok_admin_delete.md create mode 100644 docs/cli-usage/zrok_admin_delete_frontend.md create mode 100644 docs/cli-usage/zrok_admin_gc.md create mode 100644 docs/cli-usage/zrok_admin_generate.md create mode 100644 docs/cli-usage/zrok_admin_list.md create mode 100644 docs/cli-usage/zrok_admin_list_frontends.md create mode 100644 docs/cli-usage/zrok_admin_update.md create mode 100644 docs/cli-usage/zrok_admin_update_frontend.md create mode 100644 docs/cli-usage/zrok_completion.md create mode 100644 docs/cli-usage/zrok_completion_bash.md create mode 100644 docs/cli-usage/zrok_completion_fish.md create mode 100644 docs/cli-usage/zrok_completion_powershell.md create mode 100644 docs/cli-usage/zrok_completion_zsh.md create mode 100644 docs/cli-usage/zrok_config.md create mode 100644 docs/cli-usage/zrok_config_get.md create mode 100644 docs/cli-usage/zrok_config_set.md create mode 100644 docs/cli-usage/zrok_config_unset.md create mode 100644 docs/cli-usage/zrok_controller.md create mode 100644 docs/cli-usage/zrok_disable.md create mode 100644 docs/cli-usage/zrok_enable.md create mode 100644 docs/cli-usage/zrok_genmd.md create mode 100644 docs/cli-usage/zrok_invite.md create mode 100644 docs/cli-usage/zrok_release.md create mode 100644 docs/cli-usage/zrok_reserve.md create mode 100644 docs/cli-usage/zrok_share.md create mode 100644 docs/cli-usage/zrok_share_private.md create mode 100644 docs/cli-usage/zrok_share_public.md create mode 100644 docs/cli-usage/zrok_share_reserved.md create mode 100644 docs/cli-usage/zrok_status.md create mode 100644 docs/cli-usage/zrok_test.md create mode 100644 docs/cli-usage/zrok_test_endpoint.md create mode 100644 docs/cli-usage/zrok_test_loop.md create mode 100644 docs/cli-usage/zrok_version.md diff --git a/README.md b/README.md index 5462c974..f7c30875 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ![zrok](docs/images/zrok.png) -`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. diff --git a/docs/cli-usage/zrok.md b/docs/cli-usage/zrok.md new file mode 100644 index 00000000..b88cfa68 --- /dev/null +++ b/docs/cli-usage/zrok.md @@ -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 diff --git a/docs/cli-usage/zrok_access.md b/docs/cli-usage/zrok_access.md new file mode 100644 index 00000000..b416c86b --- /dev/null +++ b/docs/cli-usage/zrok_access.md @@ -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 diff --git a/docs/cli-usage/zrok_access_private.md b/docs/cli-usage/zrok_access_private.md new file mode 100644 index 00000000..c737128c --- /dev/null +++ b/docs/cli-usage/zrok_access_private.md @@ -0,0 +1,27 @@ +## zrok access private + +Create a private frontend to access a share + +``` +zrok access private [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 diff --git a/docs/cli-usage/zrok_access_public.md b/docs/cli-usage/zrok_access_public.md new file mode 100644 index 00000000..ad664c09 --- /dev/null +++ b/docs/cli-usage/zrok_access_public.md @@ -0,0 +1,26 @@ +## zrok access public + +Create a public access HTTP frontend + +``` +zrok access public [] [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 diff --git a/docs/cli-usage/zrok_admin.md b/docs/cli-usage/zrok_admin.md new file mode 100644 index 00000000..51afd92b --- /dev/null +++ b/docs/cli-usage/zrok_admin.md @@ -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 diff --git a/docs/cli-usage/zrok_admin_bootstrap.md b/docs/cli-usage/zrok_admin_bootstrap.md new file mode 100644 index 00000000..b0f2d5c4 --- /dev/null +++ b/docs/cli-usage/zrok_admin_bootstrap.md @@ -0,0 +1,28 @@ +## zrok admin bootstrap + +Bootstrap the underlying Ziti network for zrok + +``` +zrok admin bootstrap [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 diff --git a/docs/cli-usage/zrok_admin_create.md b/docs/cli-usage/zrok_admin_create.md new file mode 100644 index 00000000..ec82cf3d --- /dev/null +++ b/docs/cli-usage/zrok_admin_create.md @@ -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 diff --git a/docs/cli-usage/zrok_admin_create_frontend.md b/docs/cli-usage/zrok_admin_create_frontend.md new file mode 100644 index 00000000..d9ff3d4b --- /dev/null +++ b/docs/cli-usage/zrok_admin_create_frontend.md @@ -0,0 +1,26 @@ +## zrok admin create frontend + +Create a global public frontend + +``` +zrok admin create frontend [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 diff --git a/docs/cli-usage/zrok_admin_create_identity.md b/docs/cli-usage/zrok_admin_create_identity.md new file mode 100644 index 00000000..41a60c00 --- /dev/null +++ b/docs/cli-usage/zrok_admin_create_identity.md @@ -0,0 +1,26 @@ +## zrok admin create identity + +Create an identity and policies for a public frontend + +``` +zrok admin create identity [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 diff --git a/docs/cli-usage/zrok_admin_delete.md b/docs/cli-usage/zrok_admin_delete.md new file mode 100644 index 00000000..e95933f3 --- /dev/null +++ b/docs/cli-usage/zrok_admin_delete.md @@ -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 diff --git a/docs/cli-usage/zrok_admin_delete_frontend.md b/docs/cli-usage/zrok_admin_delete_frontend.md new file mode 100644 index 00000000..c6df2f4e --- /dev/null +++ b/docs/cli-usage/zrok_admin_delete_frontend.md @@ -0,0 +1,26 @@ +## zrok admin delete frontend + +Delete a global public frontend + +``` +zrok admin delete frontend [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 diff --git a/docs/cli-usage/zrok_admin_gc.md b/docs/cli-usage/zrok_admin_gc.md new file mode 100644 index 00000000..87124554 --- /dev/null +++ b/docs/cli-usage/zrok_admin_gc.md @@ -0,0 +1,26 @@ +## zrok admin gc + +Garbage collect a zrok instance + +``` +zrok admin gc [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 diff --git a/docs/cli-usage/zrok_admin_generate.md b/docs/cli-usage/zrok_admin_generate.md new file mode 100644 index 00000000..978ada09 --- /dev/null +++ b/docs/cli-usage/zrok_admin_generate.md @@ -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 diff --git a/docs/cli-usage/zrok_admin_list.md b/docs/cli-usage/zrok_admin_list.md new file mode 100644 index 00000000..3d704ccf --- /dev/null +++ b/docs/cli-usage/zrok_admin_list.md @@ -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 diff --git a/docs/cli-usage/zrok_admin_list_frontends.md b/docs/cli-usage/zrok_admin_list_frontends.md new file mode 100644 index 00000000..776178a0 --- /dev/null +++ b/docs/cli-usage/zrok_admin_list_frontends.md @@ -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 diff --git a/docs/cli-usage/zrok_admin_update.md b/docs/cli-usage/zrok_admin_update.md new file mode 100644 index 00000000..c3582ade --- /dev/null +++ b/docs/cli-usage/zrok_admin_update.md @@ -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 diff --git a/docs/cli-usage/zrok_admin_update_frontend.md b/docs/cli-usage/zrok_admin_update_frontend.md new file mode 100644 index 00000000..48b6fc27 --- /dev/null +++ b/docs/cli-usage/zrok_admin_update_frontend.md @@ -0,0 +1,28 @@ +## zrok admin update frontend + +Update a global public frontend + +``` +zrok admin update frontend [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 diff --git a/docs/cli-usage/zrok_completion.md b/docs/cli-usage/zrok_completion.md new file mode 100644 index 00000000..5a96796a --- /dev/null +++ b/docs/cli-usage/zrok_completion.md @@ -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 diff --git a/docs/cli-usage/zrok_completion_bash.md b/docs/cli-usage/zrok_completion_bash.md new file mode 100644 index 00000000..34fcf246 --- /dev/null +++ b/docs/cli-usage/zrok_completion_bash.md @@ -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 diff --git a/docs/cli-usage/zrok_completion_fish.md b/docs/cli-usage/zrok_completion_fish.md new file mode 100644 index 00000000..f7c3865e --- /dev/null +++ b/docs/cli-usage/zrok_completion_fish.md @@ -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 diff --git a/docs/cli-usage/zrok_completion_powershell.md b/docs/cli-usage/zrok_completion_powershell.md new file mode 100644 index 00000000..4646cbc2 --- /dev/null +++ b/docs/cli-usage/zrok_completion_powershell.md @@ -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 diff --git a/docs/cli-usage/zrok_completion_zsh.md b/docs/cli-usage/zrok_completion_zsh.md new file mode 100644 index 00000000..2ee2492c --- /dev/null +++ b/docs/cli-usage/zrok_completion_zsh.md @@ -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 diff --git a/docs/cli-usage/zrok_config.md b/docs/cli-usage/zrok_config.md new file mode 100644 index 00000000..62a7f8d2 --- /dev/null +++ b/docs/cli-usage/zrok_config.md @@ -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 diff --git a/docs/cli-usage/zrok_config_get.md b/docs/cli-usage/zrok_config_get.md new file mode 100644 index 00000000..84d6bf95 --- /dev/null +++ b/docs/cli-usage/zrok_config_get.md @@ -0,0 +1,26 @@ +## zrok config get + +Get a value from the environment config + +``` +zrok config get [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 diff --git a/docs/cli-usage/zrok_config_set.md b/docs/cli-usage/zrok_config_set.md new file mode 100644 index 00000000..ba6682e4 --- /dev/null +++ b/docs/cli-usage/zrok_config_set.md @@ -0,0 +1,26 @@ +## zrok config set + +Set a value into the environment config + +``` +zrok config set [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 diff --git a/docs/cli-usage/zrok_config_unset.md b/docs/cli-usage/zrok_config_unset.md new file mode 100644 index 00000000..566c127a --- /dev/null +++ b/docs/cli-usage/zrok_config_unset.md @@ -0,0 +1,26 @@ +## zrok config unset + +Unset a value from the environment config + +``` +zrok config unset [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 diff --git a/docs/cli-usage/zrok_controller.md b/docs/cli-usage/zrok_controller.md new file mode 100644 index 00000000..d834c7f9 --- /dev/null +++ b/docs/cli-usage/zrok_controller.md @@ -0,0 +1,26 @@ +## zrok controller + +Start a zrok controller + +``` +zrok controller [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 diff --git a/docs/cli-usage/zrok_disable.md b/docs/cli-usage/zrok_disable.md new file mode 100644 index 00000000..cd2e40ba --- /dev/null +++ b/docs/cli-usage/zrok_disable.md @@ -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 diff --git a/docs/cli-usage/zrok_enable.md b/docs/cli-usage/zrok_enable.md new file mode 100644 index 00000000..5bd05e30 --- /dev/null +++ b/docs/cli-usage/zrok_enable.md @@ -0,0 +1,27 @@ +## zrok enable + +Enable an environment for zrok + +``` +zrok enable [flags] +``` + +### Options + +``` + -d, --description string Description of this environment (default "@") + -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 diff --git a/docs/cli-usage/zrok_genmd.md b/docs/cli-usage/zrok_genmd.md new file mode 100644 index 00000000..589df0b2 --- /dev/null +++ b/docs/cli-usage/zrok_genmd.md @@ -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 diff --git a/docs/cli-usage/zrok_invite.md b/docs/cli-usage/zrok_invite.md new file mode 100644 index 00000000..74670702 --- /dev/null +++ b/docs/cli-usage/zrok_invite.md @@ -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 diff --git a/docs/cli-usage/zrok_release.md b/docs/cli-usage/zrok_release.md new file mode 100644 index 00000000..74674500 --- /dev/null +++ b/docs/cli-usage/zrok_release.md @@ -0,0 +1,26 @@ +## zrok release + +Release a reserved share + +``` +zrok release [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 diff --git a/docs/cli-usage/zrok_reserve.md b/docs/cli-usage/zrok_reserve.md new file mode 100644 index 00000000..3eb4d87e --- /dev/null +++ b/docs/cli-usage/zrok_reserve.md @@ -0,0 +1,29 @@ +## zrok reserve + +Create a reserved share + +``` +zrok reserve [flags] +``` + +### Options + +``` + --backend-mode string The backend mode {proxy, web} (default "proxy") + --basic-auth stringArray Basic authentication users (,...) + --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 diff --git a/docs/cli-usage/zrok_share.md b/docs/cli-usage/zrok_share.md new file mode 100644 index 00000000..1e086506 --- /dev/null +++ b/docs/cli-usage/zrok_share.md @@ -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 diff --git a/docs/cli-usage/zrok_share_private.md b/docs/cli-usage/zrok_share_private.md new file mode 100644 index 00000000..36172c0f --- /dev/null +++ b/docs/cli-usage/zrok_share_private.md @@ -0,0 +1,30 @@ +## zrok share private + +Share a target resource privately + +``` +zrok share private [flags] +``` + +### Options + +``` + --backend-mode string The backend mode {proxy, web} (default "proxy") + --basic-auth stringArray Basic authentication users (,... + --headless Disable TUI and run headless + -h, --help help for private + --insecure Enable insecure TLS certificate validation for +``` + +### 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 diff --git a/docs/cli-usage/zrok_share_public.md b/docs/cli-usage/zrok_share_public.md new file mode 100644 index 00000000..dc598321 --- /dev/null +++ b/docs/cli-usage/zrok_share_public.md @@ -0,0 +1,31 @@ +## zrok share public + +Share a target resource publicly + +``` +zrok share public [flags] +``` + +### Options + +``` + --backend-mode string The backend mode {proxy, web} (default "proxy") + --basic-auth stringArray Basic authentication users (,...) + --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 +``` + +### 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 diff --git a/docs/cli-usage/zrok_share_reserved.md b/docs/cli-usage/zrok_share_reserved.md new file mode 100644 index 00000000..2ae5b878 --- /dev/null +++ b/docs/cli-usage/zrok_share_reserved.md @@ -0,0 +1,29 @@ +## zrok share reserved + +Start a backend for a reserved share + +``` +zrok share reserved [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 diff --git a/docs/cli-usage/zrok_status.md b/docs/cli-usage/zrok_status.md new file mode 100644 index 00000000..63445939 --- /dev/null +++ b/docs/cli-usage/zrok_status.md @@ -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 diff --git a/docs/cli-usage/zrok_test.md b/docs/cli-usage/zrok_test.md new file mode 100644 index 00000000..08b15995 --- /dev/null +++ b/docs/cli-usage/zrok_test.md @@ -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 diff --git a/docs/cli-usage/zrok_test_endpoint.md b/docs/cli-usage/zrok_test_endpoint.md new file mode 100644 index 00000000..09ee499f --- /dev/null +++ b/docs/cli-usage/zrok_test_endpoint.md @@ -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 diff --git a/docs/cli-usage/zrok_test_loop.md b/docs/cli-usage/zrok_test_loop.md new file mode 100644 index 00000000..b2883f55 --- /dev/null +++ b/docs/cli-usage/zrok_test_loop.md @@ -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 diff --git a/docs/cli-usage/zrok_version.md b/docs/cli-usage/zrok_version.md new file mode 100644 index 00000000..7231b7ab --- /dev/null +++ b/docs/cli-usage/zrok_version.md @@ -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 diff --git a/docs/core-features/opensource.md b/docs/core-features/opensource.md index 582eab7a..29d0a070 100644 --- a/docs/core-features/opensource.md +++ b/docs/core-features/opensource.md @@ -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`. 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 -quickstart, and don't forget to star that project too. We couldn't build `zrok` without OpenZiti! \ No newline at end of file +If you are interested in learning more about OpenZiti head over to [the docs](https://docs.openziti.io/docs/learn/introduction/), +try the quickstart, and don't forget to star that project too. We couldn't build `zrok` without OpenZiti! \ No newline at end of file diff --git a/docs/core-features/sharing-private.md b/docs/core-features/sharing-private.md index da5304ed..a756e97d 100644 --- a/docs/core-features/sharing-private.md +++ b/docs/core-features/sharing-private.md @@ -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 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 -network provided by [OpenZiti](https://openziti.io). With this private, peer to peer sharing model, there will -never an attack surface available to the open internet. +network provided by [OpenZiti](https://docs.openziti.io/docs/learn/introduction/). With this private, peer to peer +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, it could be a webhook from a server running in the cloud which has `zrok` running and has been instructed diff --git a/docs/getting-started.md b/docs/getting-started.md index 95f65f05..65103bca 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -3,7 +3,18 @@ sidebar_position: 0 --- # 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. @@ -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. -[openziti]: https://docs.openziti.io/ "OpenZiti" +[openziti]: https://docs.openziti.io/docs/learn/introduction/ "OpenZiti" [ zrok-download]: https://zrok.io "Zrok Download" diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 0490cb58..7a670103 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -78,6 +78,11 @@ const config = { position: 'right', label: 'What is zrok?', }, + { + href: 'https://github.com/orgs/openziti/projects/16', + label: 'Roadmap', + position: 'right', + }, { type: 'doc', docId: 'getting-started', diff --git a/website/src/css/custom.css b/website/src/css/custom.css index 5b2e6e64..f3c884a8 100644 --- a/website/src/css/custom.css +++ b/website/src/css/custom.css @@ -169,4 +169,12 @@ a code { ::selection { color: var(--selection-font-color); 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); } \ No newline at end of file