diff --git a/docs/concepts/_backend_http.mdx b/docs/concepts/_backend_http.mdx index 085a8aa7..74be5931 100644 --- a/docs/concepts/_backend_http.mdx +++ b/docs/concepts/_backend_http.mdx @@ -1,5 +1,5 @@ -- `proxy` mode forwards requests received by the frontend to the target server ([more](/getting-started.mdx#proxy-backend-mode)) -- `web` mode serves a target folder as a file index web page ([more](/getting-started.mdx#web-backend-mode)) -- `drive` mode serves a target folder with WebDAV ([more](/guides/drives.mdx)) +- `proxy` mode forwards requests received by the frontend to the target server ([more](/concepts/http.mdx)) +- `web` mode serves a target folder as a file index web page ([more](/concepts/files.md)) +- `drive` mode serves a target folder with WebDAV ([guide](/guides/drives.mdx)) - `caddy` mode runs the built-in Caddy server with the targeted Caddyfile ([example](pathname:///simple_reverse_proxy.Caddyfile)) diff --git a/docs/concepts/http.md b/docs/concepts/http.md index a8ac241b..19c9945e 100644 --- a/docs/concepts/http.md +++ b/docs/concepts/http.md @@ -29,4 +29,4 @@ When you execute this command, you'll get a `zrok` bridge like the following: The URL shown at the top of the bridge shows the address where you can access your `public` share. -Hit `CTRL-C` or `q` in the bridge to exit it and delete the `public` share. \ No newline at end of file +Hit `CTRL-C` or `q` in the bridge to exit it and delete the `public` share. diff --git a/docs/concepts/sharing-private.mdx b/docs/concepts/sharing-private.mdx index 4425fc7a..4a23ed5e 100644 --- a/docs/concepts/sharing-private.mdx +++ b/docs/concepts/sharing-private.mdx @@ -31,7 +31,7 @@ The peer-to-peer capabilities of `zrok` are an important property of the underly Creating `private` shares is easy and is accomplished using the `zrok share private` command. Run `zrok share private` to see the usage output and to further learn how to use the command. -## Backend Modes +## Private Backend Modes The default backend mode is `proxy` which targets an HTTP URL that must be reachable by the backend. @@ -39,12 +39,7 @@ The default backend mode is `proxy` which targets an HTTP URL that must be reach zrok share private 80 ``` -### HTTP Modes - - -### Networking Modes - -- `tcpTunnel`, `udpTunnel` modes forward the data payload to the target server -- `socks` mode provides a SOCKS5 dynamic proxy on the private access bind port that tunnels TCP payloads to the share backend where they are forwarded to their destinations -- `vpn` mode provides a network layer tunnel between the private access and the share backend +- `tcpTunnel`, `udpTunnel` modes forward the data payload to the target server ([more](/concepts/tunnels.md)) +- `socks` mode provides a SOCKS5 dynamic proxy on the private access bind port that tunnels TCP payloads to the share backend where they are forwarded to their destinations ([blog](https://blog.openziti.io/the-zrok-socks-backend)) +- `vpn` mode provides a network layer tunnel between the private access and the share backend ([guide](guides/vpn/vpn.md)) diff --git a/docs/concepts/sharing-public.mdx b/docs/concepts/sharing-public.mdx index 8303d5eb..0e6f1e26 100644 --- a/docs/concepts/sharing-public.mdx +++ b/docs/concepts/sharing-public.mdx @@ -18,7 +18,7 @@ As with `private` sharing, `public` sharing does not require you to open any fir Using `public` shares is easy and is accomplished using the `zrok share public` command. Run `zrok share public` to see the command-line help and to learn how to use `public` shares. -## Backend Modes +## Public Backend Modes The default backend mode is `proxy` which targets an HTTP URL that must be reachable by the backend. @@ -26,8 +26,4 @@ The default backend mode is `proxy` which targets an HTTP URL that must be reach zrok share public 80 ``` -Public shares support any of zrok's HTTP modes. - -### HTTP Modes - diff --git a/docs/getting-started.mdx b/docs/getting-started.mdx index 9f603bf8..0b577fea 100644 --- a/docs/getting-started.mdx +++ b/docs/getting-started.mdx @@ -245,6 +245,8 @@ If we try to reload the frontend endpoint in our web browser, we'll see: ![Not Found](images/zrok_not_found.png) +[More about public shares](/concepts/sharing-public.mdx) + ### Private Shares `zrok` also provides a powerful _private_ sharing model. If I execute the following command: @@ -263,6 +265,8 @@ Rather than allowing access to your service through a public frontend, a _privat The `zrok access private wvszln4dyz9q` command can be run by any `zrok` user, allowing them to create and bind a local HTTP listener, that allows for private access to your shared resources. +[More about private shares](/concepts/sharing-private.mdx) + ### Proxy Backend Mode Without specifying a _backend mode_, the `zrok share` command will assume that you're trying to share a `proxy` resource. A `proxy` resource is usually some private HTTP/HTTPS endpoint (like a development server, or a private application) running in your local environment. Usually such an endpoint would have no inbound connectivity except for however it is reachable from your local environment. It might be running on `localhost`, or only listening on a private LAN segment behind a firewall. @@ -320,6 +324,8 @@ $ zrok release mltwsinym1s2 [ 0.230] INFO main.(*releaseCommand).run: reserved share 'mltwsinym1s2' released ``` +[More about reserved shares](/concepts/sharing-reserved.md) + ## Concepts Review In summary, `zrok` lets you easily and securely share resources with both general internet users (through _public_ sharing) and also with other `zrok` users (through _private_ sharing).