From 673206e874f63bbf179a0822c4a2216a451577b4 Mon Sep 17 00:00:00 2001 From: dovholuknf <46322585+dovholuknf@users.noreply.github.com> Date: Mon, 3 Jul 2023 12:09:53 -0400 Subject: [PATCH 1/3] remove browzer sdk --- docusaurus/docs/reference/developer/sdk/index.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/docusaurus/docs/reference/developer/sdk/index.mdx b/docusaurus/docs/reference/developer/sdk/index.mdx index bede5dc2d..7582c79f2 100644 --- a/docusaurus/docs/reference/developer/sdk/index.mdx +++ b/docusaurus/docs/reference/developer/sdk/index.mdx @@ -29,7 +29,6 @@ Pick your favorite language and start with a tutorial or sample application. You * [Reference](https://github.com/openziti/ziti-sdk-android#readme) * [Javascript SDK](https://github.com/openziti/ziti-sdk-js#readme) * [Node.js SDK](https://github.com/openziti/ziti-sdk-nodejs) - * [browZer SDK](https://github.com/openziti/ziti-sdk-browzer#readme) * C# SDK * [Repo](https://github.com/openziti/ziti-sdk-csharp#readme) * [Reference](./ziti-sdk-csharp.mdx) From ebf558e11af33af85d69c4ba68af7e2206201535 Mon Sep 17 00:00:00 2001 From: dovholuknf <46322585+dovholuknf@users.noreply.github.com> Date: Wed, 5 Jul 2023 07:23:49 -0400 Subject: [PATCH 2/3] add blurb about script functions vs systemd and link to script from zac install --- docusaurus/docs/learn/quickstarts/network/hosted.md | 9 ++++++++- docusaurus/docs/learn/quickstarts/zac/index.md | 7 +++++-- 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/docusaurus/docs/learn/quickstarts/network/hosted.md b/docusaurus/docs/learn/quickstarts/network/hosted.md index 98e75ebcd..839af5d90 100644 --- a/docusaurus/docs/learn/quickstarts/network/hosted.md +++ b/docusaurus/docs/learn/quickstarts/network/hosted.md @@ -94,7 +94,14 @@ $ createRouterSystemdFile "${ZITI_EDGE_ROUTER_NAME}" Router systemd file written to: /home/ubuntu/.ziti/quickstart/ip-172-31-23-18/ip-172-31-23-18-edge-router.service ``` -Before you run the controller and router with `systemd` you need to stop them if they're currently running. +#### The helper functions vs systemd + +The set of startController/stopController, startRouter/stopRouter are functions declared in the +[the ziti-cli-function.sh helper script](https://get.openziti.io/quick/ziti-cli-functions.sh) and are useful for running +the controller and router directly in your shell. These functions are not meant to work with systemd-enabled installs. If +you are enabling systemd, use `systemctl` to start/stop the components. During the expressInstall, the controller and router +were started using the helper scripts to complete the installation. Both should not be running, but before you run the +controller and router with `systemd` you need to stop them if they're currently running: ```bash stopRouter diff --git a/docusaurus/docs/learn/quickstarts/zac/index.md b/docusaurus/docs/learn/quickstarts/zac/index.md index ef59e8dc6..a90fd8d61 100644 --- a/docusaurus/docs/learn/quickstarts/zac/index.md +++ b/docusaurus/docs/learn/quickstarts/zac/index.md @@ -48,10 +48,13 @@ you can perform the following steps. ln -s "${ZITI_PKI}/${ZITI_CTRL_EDGE_ADVERTISED_ADDRESS}-intermediate/keys/${ZITI_CTRL_EDGE_ADVERTISED_ADDRESS}-server.key" "${ZITI_HOME}/ziti-console/server.key" ``` -1. [Optional] Emit the Ziti Console systemd file and update systemd to start the Ziti Console. If you have not sourced the - Ziti helper script, you need to in order to get the necessary function. +1. [Optional] Emit the Ziti Console systemd file and update systemd to start the Ziti Console. If you have not sourced + [the Ziti helper script](https://get.openziti.io/quick/ziti-cli-functions.sh) and you wish to have ZAC enabled with systemd, + you need to in order to get the necessary function. Either inspect the script and find the function, download and source it, + or source it directly from the internet (direct sourcing from internet shown below) ```bash + source /dev/stdin <<< "$(wget -qO- https://get.openziti.io/quick/ziti-cli-functions.sh)" createZacSystemdFile sudo cp "${ZITI_HOME}/ziti-console.service" /etc/systemd/system sudo systemctl daemon-reload From e381ddb866e32eab6db821b4f1b8bda2d118ada3 Mon Sep 17 00:00:00 2001 From: dovholuknf <46322585+dovholuknf@users.noreply.github.com> Date: Wed, 5 Jul 2023 08:49:56 -0400 Subject: [PATCH 3/3] Update docusaurus/docs/learn/quickstarts/zac/index.md /shrug fiiine tbh i'd rather have changed the "Ziti Console" to just ZAC since that's what is used throughout Co-authored-by: Ken Bingham --- docusaurus/docs/learn/quickstarts/zac/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docusaurus/docs/learn/quickstarts/zac/index.md b/docusaurus/docs/learn/quickstarts/zac/index.md index a90fd8d61..4a3b21467 100644 --- a/docusaurus/docs/learn/quickstarts/zac/index.md +++ b/docusaurus/docs/learn/quickstarts/zac/index.md @@ -48,7 +48,7 @@ you can perform the following steps. ln -s "${ZITI_PKI}/${ZITI_CTRL_EDGE_ADVERTISED_ADDRESS}-intermediate/keys/${ZITI_CTRL_EDGE_ADVERTISED_ADDRESS}-server.key" "${ZITI_HOME}/ziti-console/server.key" ``` -1. [Optional] Emit the Ziti Console systemd file and update systemd to start the Ziti Console. If you have not sourced +1. [Optional] Emit the Ziti Console systemd file and update systemd to start the Ziti Console (ZAC). If you have not sourced [the Ziti helper script](https://get.openziti.io/quick/ziti-cli-functions.sh) and you wish to have ZAC enabled with systemd, you need to in order to get the necessary function. Either inspect the script and find the function, download and source it, or source it directly from the internet (direct sourcing from internet shown below)