From 3b221c6dbd40154cde19ff179c5c5dea8887522a Mon Sep 17 00:00:00 2001 From: "mike.guthrie" Date: Wed, 22 Jan 2025 14:10:24 -0500 Subject: [PATCH] Rework getting started doc Amended with signature --- docs/getting-started.mdx | 67 +++++++++++++++++++--------------------- 1 file changed, 32 insertions(+), 35 deletions(-) diff --git a/docs/getting-started.mdx b/docs/getting-started.mdx index 0b577fea..0defa8cd 100644 --- a/docs/getting-started.mdx +++ b/docs/getting-started.mdx @@ -8,46 +8,43 @@ import { AssetsProvider } from '@site/src/components/assets-context'; import DownloadCard from '@site/src/components/download-card'; import DownloadCardStyles from '@site/src/css/download-card.module.css'; +## Share your network resources within minutes -## Get an Account +Easily share private network resources with public internet users, securely, without having to alter any of your local network configuration. +You can share resource using [NetFoundry's cloud-hosted zrok](https://myzrok.io/), +or follow our [self-hosted guide](/docs/category/self-hosting/) to manage your own installation. - - - - -

Hosted zrokNet

- - - Use NetFoundry's public zrok instance. - - - - - - - - - - - -

Self-Hosted zrok

- - - Run a zrok instance on Linux, Docker, or Kubernetes. - - - - - - - - - +* Download the binary for your platform [here](https://github.com/openziti/zrok/releases/latest) +* Sign up for a myzrok.io account [here](https://myzrok.io/) to enable your personal share token +* Run `zrok enable ` to enable your shell environment for sharing +* Run `zrok share public localhost:8080` to start your first share! +![zrok share public](images/zrok_share_public.png) -## What's a zrok? +Access your share from anywhere! + +``` +$ curl -s https://dslno640nct4.share.zrok.io | head + + + + + + + + +``` + +zrok provides several different share types, including: + +* [public shares](docs/concepts/sharing-public/) for [web services](docs/concepts/http/) or [files](docs/concepts/files/) +* [private shares for web services or files](docs/concepts/sharing-private/) +* [reserved shares](docs/concepts/sharing-reserved/) +* [tcpTunnel shares](docs/concepts/tunnels/) +* [udpTunnel shares](docs/concepts/tunnels/) +* [drives](docs/guides/drives/) +* [vpn](docs/guides/vpn/) -`zrok` (*/ziːɹɒk/ ZEE-rock*) is a secure, open-source, self-hostable sharing platform that simplifies shielding and sharing network services or files. There's a hardened zrok-as-a-service offering available at [zrok.io](https://zrok.io) with a generous free tier. ## Open Source