Getting Started with zrok
Get an Account
-Hosted zrokNet
Use NetFoundry's public zrok instance.
Self-Hosted zrok
Run a zrok instance on Linux, Docker, or Kubernetes.
What's a zrok?
-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 with a generous free tier.
Getting Started with zrok
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 with a generous free tier.
Your First Share
+-
+
- Get an account token +
Hosted zrok
Use NetFoundry's public zrok instance.
Self-Hosted zrok
Run a zrok instance on Linux, Docker, or Kubernetes.
-
+
- + + +
-
+
Enable zrok for your user environment
++zrok enable <your_account_token>
+ -
+
Share
+http://localhost:8080+zrok share public 8080
+ -
+
Visit the public URL displayed in your terminal
+
+
+
Share Backend Modes
+zrok shares can be public or private, with different options for backend modes, including:
+-
+
- Public shares for web services or files +
- Private shares for web services or files +
- TCP Tunnels +
- UDP Tunnels +
- File Drives +
- VPN +
Open Source
zrok is licensed under Apache 2.0.
Check the roadmap if you're thinking about the future. We would love to hear your ideas for zrok!
Installing the zrok Command
Windows
macOS
Linux
Enabling Your zrok Environment
-After you have an account, you can enable your zrok environment.
After you have an account, 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.
When your zrok account was created, the service generated a secret token that identifies and authenticates in a single step. Protect your secret token as if it were a password, or an important account number; it's a secret, protect it.
When we left off you had downloaded, extracted, and configured your zrok environment. In order to use that environment with your account, you'll need to enable it. Enabling an environment generates a secure identity and the necessary underlying security policies with the OpenZiti network hosting the zrok service.
Resources
- Learn about OpenZiti -