extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2025-01-25 07:19:11 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #816 from openziti/doc-win-install

Browse Source 
refine windows installation instructions
This commit is contained in:
Kenneth Bingham 2025-01-07 13:00:21 -05:00 committed by GitHub
commit d941f72d98
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 17 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@ -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

28
docs/guides/install/windows.mdx
View File

@ -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.
@ -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.