From 538037aa8f762b0e0dca33c4333f5248a9698287 Mon Sep 17 00:00:00 2001 From: Amit Bezalel Date: Fri, 4 Aug 2017 23:11:41 -0400 Subject: [PATCH 1/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 366b812..3e2eca6 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ but the code is already working (see main, proxy_test & player_test)** - TigerVnc(client) ## Usage -**Some very usable cmdline executables are Coming Soon...** +**download cmdline executables from the release section** Code samples can be found by looking at: * main.go (fbs recording vnc client) From 57fdfe914de89e5d5d41c67ce608c613781429d1 Mon Sep 17 00:00:00 2001 From: Amit Bezalel Date: Fri, 4 Aug 2017 23:13:28 -0400 Subject: [PATCH 2/6] Update README.md --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3e2eca6..aa8a58b 100644 --- a/README.md +++ b/README.md @@ -22,9 +22,8 @@ but the code is already working (see main, proxy_test & player_test)** **download cmdline executables from the release section** Code samples can be found by looking at: -* main.go (fbs recording vnc client) - * Connects, records to FBS file - * Programmed to quit after 10 seconds +* player/main.go (fbs recording vnc client) +    * Connects as client, records to FBS file * proxy/proxy_test.go (vnc proxy with recording) * Listens to both Tcp and WS ports * Proxies connections to a hard-coded localhost vnc server From b448d0235a67dec64cef9ddc306ed9bf95828084 Mon Sep 17 00:00:00 2001 From: Amit Bezalel Date: Sun, 6 Aug 2017 00:48:08 +0300 Subject: [PATCH 3/6] Update README.md --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index aa8a58b..e12ca70 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,7 @@ An RFB proxy, written in go that can save and replay FBS files * can also be used as: * a screen recorder vnc-client * a replay server to show fbs recordings to connecting clients - -**This is still a work in progress, and requires some error handling and general tidying up, -but the code is already working (see main, proxy_test & player_test)** + - tested on tight encoding with: - Tightvnc (client + java client + server) - FBS player (tightVnc Java player) From c75e9ccc9c278770e2c3e9ac4295c5507eaa31dd Mon Sep 17 00:00:00 2001 From: Amit Bezalel Date: Sun, 6 Aug 2017 00:51:20 +0300 Subject: [PATCH 4/6] Update README.md --- README.md | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index e12ca70..d136190 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ # VncProxy An RFB proxy, written in go that can save and replay FBS files -* supports all modern encodings & most useful pseudo-encodings -* supports multiple VNC client connections & multi servers (chosen by sessionId) -* supports being a "websockify" proxy (for web clients like NoVnc) -* produces FBS files compatible with tightvnc player (while using tight's default 3Byte color format) -* can also be used as: - * a screen recorder vnc-client - * a replay server to show fbs recordings to connecting clients +* Supports all modern encodings & most useful pseudo-encodings +* Supports multiple VNC client connections & multi servers (chosen by sessionId) +* Supports being a "websockify" proxy (for web clients like NoVnc) +* Produces FBS files compatible with tightvnc player (while using tight's default 3Byte color format) +* Can also be used as: + * A screen recorder vnc-client + * A replay server to show fbs recordings to connecting clients -- tested on tight encoding with: +- Tested on tight encoding with: - Tightvnc (client + java client + server) - FBS player (tightVnc Java player) - NoVnc(web client) @@ -16,10 +16,14 @@ An RFB proxy, written in go that can save and replay FBS files - VineVnc(server) - TigerVnc(client) -## Usage -**download cmdline executables from the release section** +## Usage: -Code samples can be found by looking at: +### Executables (see releases) +* proxy - the actual recording proxy, supports opening tcp & ws ports and recording traffic to fbs files +* recorder - connects to a vnc server as a client and records the screen +* player - a toy player that will replay a given fbs file to all incoming connections + +### Code usage examples * player/main.go (fbs recording vnc client)    * Connects as client, records to FBS file * proxy/proxy_test.go (vnc proxy with recording) From 6f8d591789179bfa5eeed5513e7a9cab15a5a138 Mon Sep 17 00:00:00 2001 From: Amit Bezalel Date: Sun, 6 Aug 2017 00:52:17 +0300 Subject: [PATCH 5/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d136190..f3d4982 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ An RFB proxy, written in go that can save and replay FBS files ## Usage: ### Executables (see releases) -* proxy - the actual recording proxy, supports opening tcp & ws ports and recording traffic to fbs files +* proxy - the actual recording proxy, supports listening to tcp & ws ports and recording traffic to fbs files * recorder - connects to a vnc server as a client and records the screen * player - a toy player that will replay a given fbs file to all incoming connections From aff3a20d4aeac10be18121d02f6a8899bd6a76c9 Mon Sep 17 00:00:00 2001 From: Amit Bezalel Date: Sun, 6 Aug 2017 00:52:54 +0300 Subject: [PATCH 6/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f3d4982..2b8a4de 100644 --- a/README.md +++ b/README.md @@ -57,4 +57,4 @@ The Recorder uses channels and runs in parallel to avoid hampering the communica ![Image of Arch](https://github.com/amitbet/vncproxy/blob/master/architecture/player-arch.png?raw=true) -The code is based on several implementations of go-vnc including the original one by *Mitchell Hashimoto*, and the recentely active fork which belongs to *Vasiliy Tolstov*. +The code is based on several implementations of go-vnc including the original one by *Mitchell Hashimoto*, and the recentely active fork by *Vasiliy Tolstov*.