Skip to content

Commit

Permalink
Merge pull request #551 from openziti/try-to-clarify-doc
Browse files Browse the repository at this point in the history
Try to clarify doc
  • Loading branch information
dovholuknf authored Jul 5, 2023
2 parents 5b57b95 + e381ddb commit 437909c
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 4 deletions.
9 changes: 8 additions & 1 deletion docusaurus/docs/learn/quickstarts/network/hosted.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 5 additions & 2 deletions docusaurus/docs/learn/quickstarts/zac/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 (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)

```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
Expand Down
1 change: 0 additions & 1 deletion docusaurus/docs/reference/developer/sdk/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

1 comment on commit 437909c

@vercel
Copy link

@vercel vercel bot commented on 437909c Jul 5, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

ziti-doc – ./

ziti-doc-openziti.vercel.app
ziti-doc-docusaurus.vercel.app
ziti-doc-git-main-openziti.vercel.app

Please sign in to comment.