From 907529098251c458ce86a15b88f0451ea5378ab7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dar=C3=ADo=20Here=C3=B1=C3=BA?= Date: Mon, 5 Feb 2018 09:29:15 -0300 Subject: [PATCH] Minor changes (proposals) --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5451ed1..cbea871 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ platform for operating distributed systems in the DataCenter or in the Cloud. Terminal sessions may include cryptographic secrets, personally identifiable information, or other information which should not be disclosed. -The client ttyspy acts like the script(1) command, except rather than writing a +The client ttyspy acts like the `script(1)` command, except rather than writing a local file it sends the terminal session to (presumably secure) terminal session archive server. To protect the contents of the terminal session and ensure the session is sent to the correct server, TLS with mutual certificate @@ -19,8 +19,8 @@ the architecture and configuration. ## Client -The client functions as script(1) with the typescript output file piped to -curl(1). Originally it was going to be implemented by wrapping these two +The client functions as `script(1)` with the typescript output file piped to +`curl(1)`. Originally it was going to be implemented by wrapping these two utilities using a named pipe between the two, but the non-deterministic order in which these utilities would open the pipe prevented this method. @@ -41,7 +41,7 @@ make ## Server The server is a simple Go webserver which authenticates client connections by -the client's certificate and saves HTTP POSTs to /transcript path. The server +the client's certificate and saves HTTP POSTs to `/transcript` path. The server expects a content-type of application/typescript, and X-Username, X-Hostname, X-Gecos headers to be present. Additionally if the X-Ssh-Client header is present it is preserved in the transcript file. Each transcript is saved into a