extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2025-03-13 15:08:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

updates based on PR feedback

Browse Source
This commit is contained in:
Mike Guthrie 2025-01-24 13:35:46 -05:00
parent cf753cd49c
commit 05d8578e88
No known key found for this signature in database
GPG Key ID: 1B882E45188DB83B
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/getting-started.mdx
View File

@ -8,7 +8,10 @@ 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';
## Secure resource sharing made easy
## zrok is your secure internet sharing perimeter
`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.
<Columns className='text--center getting-started-cards'>
<Column style={{paddingBottom: 20}}>
@ -43,15 +46,13 @@ import DownloadCardStyles from '@site/src/css/download-card.module.css';
</Column>
</Columns>
* Sign up for a hosted zrok account in the link above to enable your account token
* Download the zrok binary for your platform [here](#installing-the-zrok-command)
* Run `zrok enable <your_account_token>` to enable your shell environment for sharing
* Run `zrok share public localhost:8080` to start your first share!
* 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!
![zrok share public](images/zrok_share_public.png)
The zrok public share is accessible from anywhere!
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)
@ -111,7 +112,7 @@ If [sharing privately](./concepts/sharing-private.mdx), only users with the shar
## Enabling Your zrok Environment
After you have [an account](#secure-resource-sharing-made-easy), you can enable your `zrok` environment.
After you have [an account](#zrok-is-your-secure-internet-sharing-perimeter), you can enable your `zrok` environment.
A zrok environment usually refers to an enabled device where shares and accesses can be created, .e.g., `~/.zrok` on a Unix machine. It can be a specific user's environment or a system-wide agent's environment owned by the administrator.