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

Rework getting started doc

Browse Source 
Amended with signature
This commit is contained in:
mike.guthrie 2025-01-22 14:10:24 -05:00 committed by Mike Guthrie
parent ac1a4a61c7
commit 3b221c6dbd
No known key found for this signature in database
GPG Key ID: 1B882E45188DB83B
1 changed files with 32 additions and 35 deletions

67
docs/getting-started.mdx
View File

@ -8,46 +8,43 @@ import { AssetsProvider } from '@site/src/components/assets-context';
import DownloadCard from '@site/src/components/download-card'; import DownloadCard from '@site/src/components/download-card';
import DownloadCardStyles from '@site/src/css/download-card.module.css'; 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.
<Columns className='text--center getting-started-cards'> * Download the binary for your platform [here](https://github.com/openziti/zrok/releases/latest)
<Column style={{paddingBottom: 20}}> * Sign up for a myzrok.io account [here](https://myzrok.io/) to enable your personal share token
<Card shadow='tl'> * Run `zrok enable <your_token>` to enable your shell environment for sharing
<CardHeader> * Run `zrok share public localhost:8080` to start your first share!
<h3>Hosted zrokNet</h3>
</CardHeader>
<CardBody>
Use NetFoundry's public zrok instance.
</CardBody>
<CardFooter>
<a href="https://myzrok.io/">
<button className='button button--secondary button--block'>Get an Account</button>
</a>
</CardFooter>
</Card>
</Column>
<Column style={{paddingBottom: 20}}>
<Card shadow='tl'>
<CardHeader>
<h3>Self-Hosted zrok</h3>
</CardHeader>
<CardBody>
Run a zrok instance on Linux, Docker, or Kubernetes.
</CardBody>
<CardFooter>
<a href="/docs/category/self-hosting/">
<button className='button button--secondary button--block'>Guides</button>
</a>
</CardFooter>
</Card>
</Column>
</Columns>
![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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="theme-color" content="#000000"/>
<meta name="description" content="zrok ui"/>
<link rel="preconnect" href="https://fonts.googleapis.com">
```
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 ## Open Source