diff --git a/docs/guides/agent/index.mdx b/docs/guides/agent/index.mdx index 6727cdae..4be961e1 100644 --- a/docs/guides/agent/index.mdx +++ b/docs/guides/agent/index.mdx @@ -7,7 +7,7 @@ The zrok Agent centralizes management of your zrok shares and accesses. It provi ## Tutorial -Run the agent in the foreground. +Run the Agent in the foreground. ```bash zrok agent @@ -19,9 +19,9 @@ In another terminal, open the 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 zrok share public 8080 @@ -31,9 +31,9 @@ zrok share public 8080 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 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' ``` -Start sharing the reserved share with the agent. +Start sharing the reserved share with the Agent. ```bash 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" ``` -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 zrok agent status @@ -73,7 +73,7 @@ zrok agent status ### 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) - 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 -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. -- 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. -- You can stop and restart individual shares/accesses without terminating the agent. +- 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 `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. - 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`. ### 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 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 - Create new shares and accesses using simple UI widgets