summaryrefslogtreecommitdiffstats
path: root/BrowserSource/Proxy/README.md
diff options
context:
space:
mode:
authoryum <yum.food.vr@gmail.com>2023-07-03 18:44:43 -0700
committeryum <yum.food.vr@gmail.com>2023-07-03 19:36:13 -0700
commit76ae7c28ea6224b2c919122d5dc71bcc00a0ecaa (patch)
tree9723fd02715d747cfc439d1f66d36821a56069e9 /BrowserSource/Proxy/README.md
parent7888ccc96d001512dd3bdc01f299856e86c876f5 (diff)
Begin work on proxy server
Create a simple server with 3 endpoints: * /create_session: Create a session and return its identifier. * /set_transcript: Update a session's transcript. * /get_transcript: Fetch a session's transcript. Right now the session ID provides authentication *and* authorization. There is no public/private ID so you have to trust whoever you share your ID with. IDs are long and generated by the server, so it should be somewhat secure against low-effort hacking. Other updates: * Drop whisper_requirements.txt - no longer needed. * Vendor curl to make it easier to interact with the server. TODO: * Fuzz test the server.
Diffstat (limited to 'BrowserSource/Proxy/README.md')
-rw-r--r--BrowserSource/Proxy/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/BrowserSource/Proxy/README.md b/BrowserSource/Proxy/README.md
new file mode 100644
index 0000000..6c986b2
--- /dev/null
+++ b/BrowserSource/Proxy/README.md
@@ -0,0 +1,12 @@
+This is a Linux server. It receives transcripts from TaSTT and serves them to
+peers using a session identifier. It serves the use case where a mute player
+wishes to show their transcript on a friend's stream.
+
+Dependencies:
+* clang-15
+* cmake
+* fmtlib/fmt
+
+To build:
+./build-foss.sh
+make