extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2025-06-20 17:58:50 +02:00
Code Issues Packages Projects Releases Wiki Activity

consistently capitalize Agent in the agent landing page

Browse Source
This commit is contained in:
Kenneth Bingham 2025-04-01 12:04:32 -04:00
parent cbef577384
commit 085b7dc6bd
No known key found for this signature in database
GPG Key ID: 31709281860130B6
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/guides/agent/index.mdx
View File

@ -7,7 +7,7 @@ The zrok Agent centralizes management of your zrok shares and accesses. It provi
## Tutorial ## Tutorial
Run the agent in the foreground. Run the Agent in the foreground.
```bash ```bash
zrok agent zrok agent
@ -19,9 +19,9 @@ In another terminal, open the console.
zrok agent console zrok agent console
``` ```
You should see the agent UI in your default web browser. You should see the Agent UI in your default web browser.
Start sharing a public share with the agent. Start sharing a public share with the Agent.
```bash ```bash
zrok share public 8080 zrok share public 8080
@ -31,9 +31,9 @@ zrok share public 8080
token:"zje5x8p0k9pi" frontendEndpoints:"https://zje5x8p0k9pi.share.zrok.io" token:"zje5x8p0k9pi" frontendEndpoints:"https://zje5x8p0k9pi.share.zrok.io"
``` ```
You will see the new public share in the agent UI and you can access it at the public share URL. You will see the new public share in the Agent UI and you can access it at the public share URL.
Reserve a private share for the agent to share. Reserve a private share for the Agent to share.
```bash ```bash
zrok reserve private 8080 --closed --unique-name "myshare" zrok reserve private 8080 --closed --unique-name "myshare"
@ -43,7 +43,7 @@ zrok reserve private 8080 --closed --unique-name "myshare"
[ 1.883] INFO main.(*reserveCommand).run: your reserved share token is 'myshare' [ 1.883] INFO main.(*reserveCommand).run: your reserved share token is 'myshare'
``` ```
Start sharing the reserved share with the agent. Start sharing the reserved share with the Agent.
```bash ```bash
zrok share reserved "myshare" zrok share reserved "myshare"
@ -54,9 +54,9 @@ zrok share reserved "myshare"
token:"myshare" backendMode:"proxy" shareMode:"private" target:"http://127.0.0.1:8080" token:"myshare" backendMode:"proxy" shareMode:"private" target:"http://127.0.0.1:8080"
``` ```
You will see the new reserved share in the agent UI and you can access it by running `zrok access "myshare"` on another device where you have enabled the same zrok account, since the share was reserved with closed permission mode. You will see the new reserved share in the Agent UI and you can access it by running `zrok access "myshare"` on another device where you have enabled the same zrok account, since the share was reserved with closed permission mode.
Check the status of the agent's shares and accesses. Check the status of the Agent's shares and accesses.
```bash ```bash
zrok agent status zrok agent status
@ -73,7 +73,7 @@ zrok agent status
### Running the Agent in the background ### Running the Agent in the background
You can keep the agent running reliably in the background by installing the agent service in Windows or Linux. You can keep the Agent running reliably in the background by installing the Agent service in Windows or Linux.
- Windows - [set up the Windows system service](/guides/agent/windows-service/index.mdx) - Windows - [set up the Windows system service](/guides/agent/windows-service/index.mdx)
- Linux - [install the Linux package `zrok-agent`](/guides/agent/linux-service.mdx) - Linux - [install the Linux package `zrok-agent`](/guides/agent/linux-service.mdx)
@ -82,26 +82,26 @@ You can keep the agent running reliably in the background by installing the agen
### Centralized Management ### Centralized Management
Without the agent running, each time you execute a `zrok share` or `zrok access` command, a separate process is created to handle that specific share or access. Without the Agent running, each time you execute a `zrok share` or `zrok access` command, a separate process is created to handle that specific share or access.
When the agent is running: When the Agent is running:
- All shares and accesses are managed by a single agent process. - All shares and accesses are managed by a single Agent process.
- The agent provides a web UI for monitoring and managing your shares and accesses. - The Agent provides a web UI for monitoring and managing your shares and accesses.
- The `zrok share` and `zrok access` commands delegate their operations to the running agent. - The `zrok share` and `zrok access` commands delegate their operations to the running Agent.
- You can stop and restart individual shares/accesses without terminating the agent. - You can stop and restart individual shares/accesses without terminating the Agent.
- The Agent will remember and automatically restart your shares started with `share reserved`, and any accesses started with `access private`. - The Agent will remember and automatically restart your shares started with `share reserved`, and any accesses started with `access private`.
- The Agent will not restart regular, ephemeral shares started with `share private` or `share public`. - The Agent will not restart regular, ephemeral shares started with `share private` or `share public`.
### Agent Console ### Agent Console
The agent provides a web-based console interface that can be accessed with: The Agent provides a web-based console interface that can be accessed with:
```bash ```bash
zrok agent console zrok agent console
``` ```
This command opens your default web browser to the agent's UI, where you can: This command opens your default web browser to the Agent UI, where you can:
- View the status of all your active shares and accesses - View the status of all your active shares and accesses
- Create new shares and accesses using simple UI widgets - Create new shares and accesses using simple UI widgets