diff --git a/README.md b/README.md index a8f2fb1d..3eba47b1 100644 --- a/README.md +++ b/README.md @@ -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_. diff --git a/docs/getting-started.mdx b/docs/getting-started.mdx index de4f9f18..f49f74e0 100644 --- a/docs/getting-started.mdx +++ b/docs/getting-started.mdx @@ -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