Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs tweaks #946

Merged
merged 1 commit into from
Sep 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ We'll cover the following topics:

You must create the router in the controller first with [the web console](/guides/deployments/10-linux/30-console.mdx) or [the CLI](/guides/deployments/10-linux/20-router/40-cli-mgmt.md).

After creating the router, save the enrollment token (JWT) and use it to finish configuring the router deployment.
After [creating the router](/guides/deployments/10-linux/20-router/40-cli-mgmt.md#create-a-router), save the enrollment token (JWT) and provide the file path to the router during the configuration step below.

## Install the Router Package

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The [`identity`](/reference/30-configuration/conventions.md#identity) configurat

If present, the `server_key` signs the router's server certificate request. Otherwise, the `key` sub-property is used for both client and server certificate.

The private keys' values are assumed to be `file://` URLs if unspecified. Alternatives include `pkcs11://` and `parsec://` URLs for hardware keys.
The private keys' values are assumed to be `file://` URLs if unspecified. Alternatives include `pkcs11://` and `parsec://` URLs for [hardware keys](/guides/hsm/index.md).

## Optional Capabilities

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import CliLogin from '/docs/_cli-login.md'

<TabItem value="TunnelerEnabled" label="Router with Tunneler">

The tunneler flag must be administratively set when the router is created or updated. There are no administrative flags pertaining to the router's listeners.
The tunneler flag must be administratively set when the router is created or updated or the router will not start.

<br />

Expand Down
35 changes: 28 additions & 7 deletions docusaurus/docs/guides/deployments/10-linux/30-console.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,51 @@ title: Console Deployment
sidebar_label: Console
---

The console must be bound to the same web listener as the controller's management API.
## Installation

1. On the controller host, download the latest release of the console from GitHub. You can use any console version >= 3.0.0.
### Install the Package

The package installs the console files in `/opt/openziti/share/console`.

```text title="Install the console package"
sudo apt install openziti-console
```

Or, configure the package repository and install with this one-liner.

```text title="Configure the package repository and install openziti-console"
curl -sS https://get.openziti.io/install.bash | sudo bash -s openziti-console
```

### Install from GitHub

Console versions >= 3.0.0 from GitHub may be used.

1. Download a release.

```text
wget https://github.com/openziti/ziti-console/releases/latest/download/ziti-console.zip
```

1. Unzip the console in the controller's working directory.
1. Unzip in a directory that is mounted the controller's filesystem namespace.

```text
sudo unzip -d /var/lib/ziti-controller/zac ./ziti-console.zip
sudo mkdir -p /opt/openziti/share/console
sudo unzip -d /opt/openziti/share/console ./ziti-console.zip
```

1. In **/var/lib/ziti-controller/config.yml**, ensure you have an API binding `zac` on the same web listener where `edge-management` is bound. Ensure the `location` matches the path where you unzipped the console.
## Configuration

1. In **/var/lib/ziti-controller/config.yml**, ensure you have an API binding `zac` on the same web listener where `edge-management` is bound. Ensure the `location` matches the path to the console files.

```text
- binding: zac
options:
location: /var/lib/ziti-controller/zac
location: /opt/openziti/share/console
indexFile: index.html
```

1. Restart the controller service to apply the changes.
1. Restart the controller service if you edited the configuration.

```text
sudo systemctl restart ziti-controller.service
Expand Down
10 changes: 5 additions & 5 deletions docusaurus/docs/guides/deployments/20-docker/30-console.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Deploy the Console
sidebar_label: Console
---

This article is about deploying the console as a single-page application (SPA) embedded in the controller's API running in a container.
This article is about enabling the console on a controller that is running in a container.

1. Configure the controller

Expand Down Expand Up @@ -34,9 +34,9 @@ This article is about deploying the console as a single-page application (SPA) e

## Upgrade

You can mount a different version of the console on the controller container if you don't want to use the version that comes with it.
The controller container includes the latest version of the console. You can instead mount console versions >= 3.0.0.

1. On the Docker host, download the latest release of the console from GitHub. You can use any console version >= 3.0.0.
1. Download a release.

```text
wget https://github.com/openziti/ziti-console/releases/latest/download/ziti-console.zip
Expand All @@ -49,13 +49,13 @@ You can mount a different version of the console on the controller container if
chmod -R a+rX ./ziti-console
```

1. Mount the console directory on the controller container.
1. Mount the console files read-only on the controller container.

```text
services:
ziti-controller:
volumes:
- ./ziti-console:/ziti-console
- ./ziti-console:/ziti-console:ro
```

1. Restart the controller service to apply the changes.
Expand Down