diff --git a/docs/getting-started.mdx b/docs/getting-started.mdx index 5e2cd832..9f4aead9 100644 --- a/docs/getting-started.mdx +++ b/docs/getting-started.mdx @@ -13,6 +13,9 @@ import DownloadCardStyles from '@site/src/css/download-card.module.css'; `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 [myzrok.io](https://myzrok.io) with a generous free tier. +### Your First Share + +1. Get an account token. @@ -46,13 +49,20 @@ There's a hardened zrok-as-a-service offering available at [myzrok.io](https://m -* Sign up for a zrok account in the link above to enable your account token -* [Download the zrok binary](#installing-the-zrok-command) -* Run `zrok enable ` to enable your shell environment -* Run `zrok share public 8080` to start your first share! - +2. [Download the zrok binary](#installing-the-zrok-command) +3. Enable zrok for your [user environment](#enabling-your-zrok-environment) +``` +zrok enable +``` +4. Share `http://localhost:8080` +``` +zrok share public 8080 +``` +5. Visit the public URL displayed in your terminal ![zrok share public](images/zrok_share_public.png) +## Share Backend Modes + zrok shares can be public or private, with different options for backend modes, including: * [Public shares](./concepts/sharing-public.mdx) for [web services](./concepts/http.md) or [files](./concepts/files.md)