tidy linux install instructions

openziti · Oct 2, 2023 · bd8220d · bd8220d
1 parent 51bfe2d
commit bd8220d
Showing 1 changed file with 25 additions and 25 deletions.
diff --git a/docusaurus/docs/reference/tunnelers/linux/index.md b/docusaurus/docs/reference/tunnelers/linux/index.md
@@ -7,11 +7,10 @@ import TabItem from '@theme/TabItem';
 
 ## The Ziti Tunneller
 
-`ziti-edge-tunnel` is the general purpose tunneller CLI and can also run as a systemd daemon.
-
-The purpose of the tunneller is to configure host access. This means all users and all processes on the host will share
-the same level of access. This is accomplished by configuring the OS to have an on-board OpenZiti DNS nameserver and IP
-routes for authorized OpenZiti Services.
+`ziti-edge-tunnel` is a general-purpose tunneller daemon controlled by an IPC socket. The purpose of the tunneller is to
+configure host access. This means all users and all processes on the host will share the same level of access. This is
+accomplished by configuring the OS to have an on-board OpenZiti DNS nameserver and IP routes for authorized OpenZiti
+Services.
 
 ## Install Linux Package
 
@@ -27,13 +26,13 @@ Additionally, there are executable downloads available for arm/v7 (32bit) for [m
 installation](#manual-installation).
 
 :::note
-It is not necessary to manually enroll the identity when using the RPM or DEB package. Just install the token in the
-identities directory with file owner "ziti" and it will be enrolled and cleaned up when you start the service.
+It is not necessary to manually enroll the identity when using the RPM or DEB package. Install the token in the
+identities directory with file owner "ziti" and it will be enrolled and cleaned up when the service starts.
 :::
 
 ### Installing the DEB
 
-1. Run the script for your OS to install `ziti-edge-tunnel`.
+1. Select an OS to see the appropriate steps.
 
 <Tabs
   defaultValue="Ubuntu"
@@ -75,9 +74,9 @@ curl -sSLf https://get.openziti.io/tun/scripts/install-ubuntu.bash | bash
 | 10 Buster   | Bionic 18.04 | x86_64        |
 |  9 Stretch  | Xenial 16.04 | x86_64        |
 
-This example subscribes you to the Ubuntu `focal` repo which will work well in most cases. Alternatively, you may refer
-to the table to find the Ubuntu release name that is the contemporary of your Debian release. Then, substitute the
-Ubuntu release name for `focal` in the `/etc/apt/sources.list.d/openziti.list` file.
+This example subscribes to the Ubuntu `focal` repo. Refer to the table to find the Ubuntu release name that is the
+contemporary of a Debian release. Substitute the Ubuntu release name for `focal` in the
+`/etc/apt/sources.list.d/openziti.list` file.
 
 ```text
 (
@@ -109,7 +108,7 @@ sudo apt install ziti-edge-tunnel
 
 ### Installing the RPM
 
-1. Create a repo file like `/etc/yum.repos.d/openziti.repo` matching the appropriate example below for your OS.
+1. Create a repo file like `/etc/yum.repos.d/openziti.repo` matching the OS.
 
 <Tabs
   defaultValue="RedHat"
@@ -182,7 +181,7 @@ repo_gpgcheck=1
 </TabItem>
 </Tabs>
 
-2. Run `sudo yum update` to refresh your repo data cache. Optionally, you may wish to also install all available updates.
+2. Run `sudo yum update` to refresh the repo data cache.
 2. Run `sudo yum install ziti-edge-tunnel` to install the RPM.
 2. Enable and start the service
 
@@ -196,9 +195,10 @@ repo_gpgcheck=1
 
 ### Restart to Load All in Identity Directory
 
-The tunneler will load all identities in the `--identity-dir` directory. The identities directory created by the package
-installation is `/opt/openziti/etc/identities`. You may add identity files to this directory by copying the identity
-file into the directory and setting permissions for group `ziti`.
+The tunneler will load all identities in the `--identity-dir` directory. The default location for identities is is
+`/opt/openziti/etc/identities`. Add identity files to this directory by copying the identity file into the directory and
+setting permissions for group `ziti` so the tunneler service may delete JWT enrollment tokens and read and write the
+JSON identity configuration files.
 
 ```text
 sudo chown -cR :ziti        /opt/openziti/etc/identities
@@ -213,9 +213,9 @@ sudo systemctl restart ziti-edge-tunnel.service
 
 ### Load a Single Identity Without Restarting
 
-This sends an IPC command to the running tunneler. You must have write permission on the IPC socket
-(`/tmp/.ziti/ziti-edge-tunnel.sock`). You may run this command as yourself instead of user `ziti` if you are a member of
-group `ziti`.
+This sends an IPC command to the running tunneler and requires write permission on the IPC socket
+(`/tmp/.ziti/ziti-edge-tunnel.sock`). Run this command as the logged in user instead of user `ziti` if a member of group
+`ziti`.
 
 ```text
 sudo -u ziti \
@@ -228,7 +228,7 @@ sudo -u ziti \
 distributed as an executable for amd64, arm, arm64 architectures. The upgrade procedure is identical to the installation
 procedure.
 
-You'll need to install the `wget` and `unzip` commands to use this example.
+Install the `wget` and `unzip` commands to use this example.
 
 ```text
 wget -q \
@@ -239,9 +239,9 @@ wget -q \
   && ./ziti-edge-tunnel version
 ```
 
-### Enroll Before You Run
+### Enroll Before Run
 
-You will need the token file or its contents to enroll. 
+A one-time token (JWT) is required to enroll.
 
 ```text
 ziti-edge-tunnel enroll --jwt ./in-file.jwt --identity ./out-file.json
@@ -259,9 +259,9 @@ ziti-edge-tunnel run --identity-dir /opt/openziti/etc/identities
 
 ## Run with Docker
 
-Please reference [the article about running the Linux tunneler in a container](./container/readme.mdx) for guidance and
-examples!
+Reference [the article about running the Linux tunneler in a container](./container/readme.mdx) for guidance and
+examples.
 
 ## Troubleshooting
 
-Please refer to [the troubleshooting guide](./linux-tunnel-troubleshooting.md)
+Refer to [the troubleshooting guide](./linux-tunnel-troubleshooting.md).