updated docs

This commit is contained in:
amit bezalel 2017-07-22 01:38:22 +03:00
parent 1307fd6d3a
commit 28c664f5cd
2 changed files with 20 additions and 11 deletions

View File

@ -1,15 +1,22 @@
# VncProxy # VncProxy
An RFB proxy, written in go that can save and replay FBS files An RFB proxy, written in go that can save and replay FBS files
* supports all modern encodings * supports all modern encodings & most useful pseudo-encodings
* supports regular and sockified (noVnc) server connnections * supports regular VNC TCP connections
* produces FBS files compatible with tightvnc player * 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: * can also be used as:
* a screen recorder vnc-client * a screen recorder vnc-client
* a replay server to show fbs recordings to connecting clients * 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, **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)** but the code is already working (see main, proxy_test & player_test)**
- tested on tight encoding with: tightvnc (client+server), noVnc(web client), chickenOfTheVnc(client), vineVnc(server), tigerVnc(client) - tested on tight encoding with:
- Tightvnc (client + java client + server)
- FBS player (tightVnc Java player)
- NoVnc(web client)
- ChickenOfTheVnc(client)
- VineVnc(server)
- TigerVnc(client)
## Usage ## Usage
**Some very usable cmdline executables are Coming Soon...** **Some very usable cmdline executables are Coming Soon...**

16
todo.md
View File

@ -1,8 +1,10 @@
#TODO:
* test proxy flow # TODO:
* create replay flow * add replay flow to proxy
* set correct status for each flow * set correct status for each flow in proxy
* move encodings to be on the framebufferupdate message object * create 2 cmdline apps (recorder & proxy) - proxy will also replay (depending on session type & cmdline flags)
* clear all messages read functions from updating stuff, move modification logic to another listener
* message read function should accept only an io.Reader, move read helper logic (readuint8) to an actual helper class * code stuff:
* move encodings to be on the framebufferupdate message object
* clear all messages read functions from updating stuff, move modification logic to another listener
* message read function should accept only an io.Reader, move read helper logic (readuint8) to an actual helper class