extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2025-01-31 10:31:48 +01:00
Code Issues Packages Projects Releases Wiki Activity

Rework steps into an ordered lis based on feedback

Browse Source
This commit is contained in:
Mike Guthrie 2025-01-27 09:38:58 -05:00
parent 05d8578e88
commit 9b83504446
No known key found for this signature in database
GPG Key ID: 1B882E45188DB83B
1 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/getting-started.mdx
View File

@ -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.
<Columns className='text--center getting-started-cards'>
<Column style={{paddingBottom: 20}}>
<Card shadow='tl'>
@ -46,13 +49,20 @@ There's a hardened zrok-as-a-service offering available at [myzrok.io](https://m
</Column>
</Columns>
* 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 <your_account_token>` 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 <your_account_token>
```
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)