Skip to content

Commit

Permalink
Improve README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ilyash-b committed May 29, 2022
1 parent 73ea10c commit 2563ad6
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
# ngs-web-ui-proxy

Work in progress.
## Background

Browser -- Websocket -- this project (transcoder) -- JSON-RPC -- NGS shell server
* NGS shell server exposes JSON-RPC over Unix socket
* We would like to connect to the NGS shell server from the browser

## NGS Web UI Proxy

This project is the transcoder/bridge between the browser and the NHS shell server.

* Exposes Websocket interface to the clients
* Talks JSON-RPC to the upstream, through Unix socket specified as command line argument

Browser -- Websocket -- this project (transcoder) -- JSON-RPC -- NGS shell server

0 comments on commit 2563ad6

Please sign in to comment.