Skip to content

Commit

Permalink
Merge pull request #816 from openziti/doc-win-install
Browse files Browse the repository at this point in the history
refine windows installation instructions
  • Loading branch information
qrkourier authored Jan 7, 2025
2 parents 81540b9 + 9c78fea commit d941f72
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 13 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
28 changes: 15 additions & 13 deletions docs/guides/install/windows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,19 @@ import styles from '@site/src/css/download-card.module.css';
</div>
</AssetsProvider>

1. Unarchive the distribution in a temporary directory:
1. In PowerShell, install in `%USERPROFILE%\bin\zrok.exe` and set the search path.

```text
New-Item -Path "$env:TEMP\zrok" -ItemType Directory -ErrorAction Stop
tar -xf .\zrok*windows*.tar.gz -C "$env:TEMP\zrok"
```

1. Install the `zrok` executable and include HOME\bin in the search PATH.

```text
$source = Join-Path -Path $env:TEMP -ChildPath "zrok\zrok.exe"
$destination = Join-Path -Path $env:USERPROFILE -ChildPath "bin\zrok.exe"
New-Item -Path $destination -ItemType Directory -ErrorAction SilentlyContinue
Copy-Item -Path $source -Destination $destination
$env:path += ";"+$destination
$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
$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 @@ -50,3 +48,7 @@ import styles from '@site/src/css/download-card.module.css';
v0.4.0 [c889005]
```

## 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 d941f72

Please sign in to comment.