Skip to content

Commit

Permalink
set the executable search path
Browse files Browse the repository at this point in the history
  • Loading branch information
qrkourier committed Jan 7, 2025
1 parent 244fb69 commit 9c78fea
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 11 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ CHANGE: Use port 80 for the default Ziti API endpoint in the zrok Docker instanc

CHANGE: Clarify OS requirements for zrok VPN

CHANGE: Set the Windows executable search path in the Windows install guide.

FEATURE: Linux service template for systemd user units (https://github.com/openziti/zrok/pull/818)

## v0.4.45
Expand Down
18 changes: 7 additions & 11 deletions docs/guides/install/windows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,19 @@ import styles from '@site/src/css/download-card.module.css';
</div>
</AssetsProvider>

1. Extract `zrok.exe` to `%USERPROFILE%\bin` and set search `%PATH%`.
1. In PowerShell, install in `%USERPROFILE%\bin\zrok.exe` and set the search path.

```text
$binDir = Join-Path -Path $env:USERPROFILE -ChildPath "bin"
New-Item -Path $binDir -ItemType Directory -ErrorAction SilentlyContinue
$latest = Get-ChildItem -Path .\zrok*windows*.tar.gz | Sort-Object LastWriteTime | Select-Object -Last 1
tar -xf $latest.FullName -C $binDir zrok.exe
$env:path += ";"+$binDir
$currentPath = [System.Environment]::GetEnvironmentVariable('PATH', [System.EnvironmentVariableTarget]::User)
if ($currentPath -notlike "*$binDir*") {
$newPath = "$currentPath;$binDir"
[System.Environment]::SetEnvironmentVariable('PATH', $newPath, [System.EnvironmentVariableTarget]::User)
$env:Path = $newPath
}
```

1. With the `zrok` executable in your path, you can then execute the `zrok` directly.
Expand All @@ -44,15 +49,6 @@ import styles from '@site/src/css/download-card.module.css';
v0.4.0 [c889005]
```

## Enable Your Environment

Enable your environment without saving the account token in shell history, i.e., `zrok enable {token}`.

```text
$zrokAccountToken=Read-Host "Enter your zrok account token" -AsSecureString;
zrok enable ([System.Runtime.InteropServices.Marshal]::PtrToStringAuto([System.Runtime.InteropServices.Marshal]::SecureStringToBSTR($zrokAccountToken)))
```

## Wintun for zrok VPN

On Windows, you must install Wintun to use zrok's VPN backend mode. See the [VPN guide](/guides/vpn/vpn.md) for more details.

0 comments on commit 9c78fea

Please sign in to comment.