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

doc tweak (#877)

Browse Source
This commit is contained in:
Michael Quigley 2025-03-14 10:38:58 -04:00
parent 3ee0b9781e
commit b03c1d46dd
No known key found for this signature in database
GPG Key ID: 9B60314A9DD20A62
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/getting-started.mdx
View File

@ -9,13 +9,8 @@ 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';
import InstallCards from '/../docs/guides/install/_install_cards.mdx'; import InstallCards from '/../docs/guides/install/_install_cards.mdx';
## 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.
:::note :::note
If you've upgraded from `v0.4.x` and you receive an error message like this: If you've upgraded to `v1.0.0` from a previous version and you receive an error message like this:
``` ```
[ERROR]: unable to create share (error getting zrok client: client version error accessing api endpoint 'https://api.zrok.io': [POST /clientVersionCheck] clientVersionCheck (status 404): {}: [POST /clientVersionCheck] clientVersionCheck (status 404): {}) [ERROR]: unable to create share (error getting zrok client: client version error accessing api endpoint 'https://api.zrok.io': [POST /clientVersionCheck] clientVersionCheck (status 404): {}: [POST /clientVersionCheck] clientVersionCheck (status 404): {})
@ -24,6 +19,12 @@ If you've upgraded from `v0.4.x` and you receive an error message like this:
Use the command `zrok rebase apiEndpoint https://api-v1.zrok.io/` to update your environment to the latest zrok endpoint. Use the command `zrok rebase apiEndpoint https://api-v1.zrok.io/` to update your environment to the latest zrok endpoint.
::: :::
## 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.
### Your First Share ### Your First Share
1. Get an account token 1. Get an account token