extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2025-04-12 21:38:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs (#812)

Browse Source
This commit is contained in:
Michael Quigley 2025-03-14 10:35:37 -04:00
parent 6640c32b20
commit 3ee0b9781e
No known key found for this signature in database
GPG Key ID: 9B60314A9DD20A62
2 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -1,5 +1,13 @@
![zrok logo](docs/images/zrok_cover.png)
**Note: If you upgrade to `v1.0.0` 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): {})
```
Use the command `zrok rebase apiEndpoint https://api-v1.zrok.io/` to update your environment for the `v1.0.0` release.
## Your Secure Internet Sharing Perimeter
`zrok` is a next-generation, peer-to-peer sharing platform built on top of [OpenZiti](https://docs.openziti.io/docs/learn/introduction/), a programmable zero-trust network overlay. `zrok` is a _Ziti Native Application_.

10
docs/getting-started.mdx
View File

@ -14,6 +14,16 @@ import InstallCards from '/../docs/guides/install/_install_cards.mdx';
`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
If you've upgraded from `v0.4.x` 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): {})
```
Use the command `zrok rebase apiEndpoint https://api-v1.zrok.io/` to update your environment to the latest zrok endpoint.
:::
### Your First Share
1. Get an account token