Forráskód Böngészése

Moved networking instructions from README.md. Some refactor.

zinobias 2 éve
szülő
commit
28a7309328
2 módosított fájl, 25 hozzáadás és 8 törlés
  1. 4 8
      README.md
  2. 21 0
      docs/Tailscale.md

+ 4 - 8
README.md

@@ -10,14 +10,10 @@ WebVM is powered by the CheerpX virtualization engine, and enables safe, sandbox
 
 
 # How to: enable networking
 # How to: enable networking
 
 
-- go to [https://webvm.io](https://webvm.io)
-- click "Tailscale Login" in the top right corner
-- log in to Tailscale (create an accout if you don't have one)
-- if you want to access the public internet, you need an Exit Node. See [here](https://tailscale.com/kb/1103/exit-nodes/) for how to set one up. If you just want to access a machine in your Tailscale Network, you don't need it
-- depending on your network speed, you may need to wait a few moments for the Tailscale Wasm module to be downloaded
-- log in with your Tailscale credentials
-- go back to the WebVM tab. You will see your IP address in the top right
-- start firing network requests!
+- Go to [https://webvm.io](https://webvm.io).
+- Click "Tailscale Login" in the top right corner.
+- Log in to Tailscale (create an account if you don't have one).
+- If you are unfamiliar with Tailscale or would like additional information see [WebVM and Tailscale](/docs/Tailscale.md).
 
 
 # How to: fork and deploy
 # How to: fork and deploy
 - Fork the repository.
 - Fork the repository.

+ 21 - 0
docs/Tailscale.md

@@ -0,0 +1,21 @@
+# Enabling networking
+- In order to access the public internet, you will need an Exit Node. See [Tailscale Exit Nodes](https://tailscale.com/kb/1103/exit-nodes/) for detailed instructions.
+	- ***Note:*** This is not required to access machines in your own Tailscale Network.
+- depending on your network speed, you may need to wait a few moments for the Tailscale Wasm module to be downloaded.
+
+**When all set:**
+- Log in with your Tailscale credentials.
+- Go back to the WebVM tab. `Connect to Tailscale` should be replaced by your IP address.
+- Start firing network requests!
+
+# Log in to Tailscale with an Auth key
+
+- Add `#authKey=<your-key>` at the end of the URL.
+- Done, you don't need to manually log in anymore.
+
+It is recommended to use an ephemeral key.
+
+# Log in to a self-hosted Tailscale network (Headscale)
+
+- Add `#controlUrl=<your-control-url>` at the end of the URL.
+- You can combine this option with `authKey` with a `&`: `#controlUrl=<url>&authKey=<key>`.