docs: add transports.md

License: MIT Signed-off-by: Lars Gierth <larsg@systemli.org>
ipfs · Jul 4, 2017 · 21e96e2 · 21e96e2
1 parent 7ad4948
commit 21e96e2
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/docs/transports.md b/docs/transports.md
@@ -0,0 +1,12 @@
+## /ws and /wss -- websockets
+
+If you want browsers to connect to e.g. `/dns4/example.com/tcp/443/wss/ipfs/QmFoo`
+
+- [ ] An SSL cert matching the `/dns4` or `/dns6` name
+- [ ] go-ipfs listening on `/ip4/127.0.0.1/tcp/8081/ws`
+  - 8081 is just an example
+  - note that it's `/ws` here, not `/wss` -- go-ipfs can't currently do SSL, see the next point
+- [ ] nginx
+  - configured with the SSL cert
+  - listening on port 443
+  - forwarding to 127.0.0.1:8081