From 8f771fc8e0f3bbeb185330320e87816aa2434eb6 Mon Sep 17 00:00:00 2001 From: Zhi Wang Date: Mon, 7 Feb 2022 12:31:09 -0500 Subject: [PATCH] Update docs --- docs/404.html | 2 +- docs/categories/index.html | 25 ++++------- docs/docs/about/index.html | 31 +++++++------- docs/docs/index.html | 30 ++++++------- docs/docs/install/index.html | 35 +++++++--------- docs/docs/record/index.html | 31 +++++++------- docs/docs/ui/index.html | 33 +++++++-------- docs/docs/vm/index.html | 33 +++++++-------- ...e50fb50da8cd74d7080f3079316ffa006c1b.json} | 2 +- ...4fe8df7743a461230c57511923615abac30b55.js} | 2 +- docs/index.html | 32 +++++++------- docs/index.xml | 2 +- docs/menu/index.html | 42 +++++++++---------- docs/sitemap.xml | 2 +- docs/tags/index.html | 25 ++++------- 15 files changed, 141 insertions(+), 186 deletions(-) rename docs/{en.search-data.min.cf01fda4defd8544061a2e23337262b5b8a853e9fa51a19761487bcf875291ac.json => en.search-data.min.3fdbc2f09c3f796e7eeb937af60ce50fb50da8cd74d7080f3079316ffa006c1b.json} (63%) rename docs/{en.search.min.d94cd9e9271fd6c7ba798461e1fbda7c357c43fe43568c26463af5c34e1cc416.js => en.search.min.28bcb0d34997b542e09ca609614fe8df7743a461230c57511923615abac30b55.js} (87%) diff --git a/docs/404.html b/docs/404.html index b786bcd..afa951f 100644 --- a/docs/404.html +++ b/docs/404.html @@ -13,7 +13,7 @@ - + diff --git a/docs/categories/index.html b/docs/categories/index.html index bca7b78..a65a388 100644 --- a/docs/categories/index.html +++ b/docs/categories/index.html @@ -13,7 +13,7 @@ - + @@ -24,7 +24,7 @@
diff --git a/docs/docs/about/index.html b/docs/docs/about/index.html index 511e28a..6e801ac 100644 --- a/docs/docs/about/index.html +++ b/docs/docs/about/index.html @@ -12,12 +12,13 @@ The program has been tested on Linux, WSL2, Raspberry Pi 3B (Debian), and MacOSX Most icons were provided by fontawesome under this license."> + About | WiTTY: Web-based interactive TTY - + @@ -27,7 +28,7 @@ Most icons were provided by fontawesome under this license.">
@@ -84,6 +76,11 @@ window (xterm.js) and creates a websocket with the server, which relays the data
+
diff --git a/docs/docs/index.html b/docs/docs/index.html index d41dba3..5f731ea 100644 --- a/docs/docs/index.html +++ b/docs/docs/index.html @@ -13,7 +13,7 @@ - + @@ -24,7 +24,7 @@
@@ -71,6 +62,11 @@
+
diff --git a/docs/docs/install/index.html b/docs/docs/install/index.html index a299834..e1b8f67 100644 --- a/docs/docs/install/index.html +++ b/docs/docs/install/index.html @@ -18,12 +18,13 @@ tar -xzvf witty_vx.x.x_xxx.tar.gz For example, use tar -xzvf witty_v1."> + Installation | WiTTY: Web-based interactive TTY - + @@ -33,7 +34,7 @@ tar -xzvf witty_vx.x.x_xxx.tar.gz
@@ -169,12 +161,17 @@ Example Use Case

graph LR -A[user on a phone] -- browser --> B[RPI: 192.168.1.1
runs WiTTY] -B -- ssh --> C[Windows: 192.168.1.2
runs SSH server ] +A[user on a phone] -- browser --> B[RPI: 192.168.1.2
runs WiTTY] +B -- ssh --> C[Windows: 192.168.1.3
runs SSH server ]

+
diff --git a/docs/docs/record/index.html b/docs/docs/record/index.html index 2551729..41659f3 100644 --- a/docs/docs/record/index.html +++ b/docs/docs/record/index.html @@ -12,12 +12,13 @@ Recorded sessions will be listed in the main window of WiTTY. You can click the WiTTY provides two sub-commands to merge and replay recorded sessions."> + Record Sessions | WiTTY: Web-based interactive TTY - + @@ -27,7 +28,7 @@ WiTTY provides two sub-commands to merge and replay recorded sessions.">
@@ -96,6 +88,11 @@ All the recorded sessions are located under the records directory.
+
diff --git a/docs/docs/ui/index.html b/docs/docs/ui/index.html index 9851ed5..f9cabc1 100644 --- a/docs/docs/ui/index.html +++ b/docs/docs/ui/index.html @@ -10,12 +10,13 @@ Sub-command Description adduser Add/update an authenticated user with their password deluser Delete an authenticated user listusers List all the authenticated users replay Replay a recorded session (set your terminal to 120x36 first) merge Merge several recorded sessions into one session run Run a specified CLI program when user connects with browser Some sub-commands have options."> + User Interface | WiTTY: Web-based interactive TTY - + @@ -25,7 +26,7 @@
@@ -146,11 +138,16 @@ Web Interface (witty run)

img

After a session has been recorded, the main window’s Recorded Sessions will list the records, as shown below. You can replay , download , rename , and delete recorded sessions.

img

-

Here is a screencast where we replay a recorded session that updates the pi-hole system. You can fully control the playback using the progress bar. Clicking on the progress bar stops the replay and fast-forwards (or fast-backwards) the screen to that location. You can scroll the screen to view the history when replay is stopped or resume the replay.

+

Here is a screencast where we replay a recorded session that updates the pi-hole system. You can fully control the playback using the progress bar. Clicking on the progress bar stops the replay and fast-forwards (or fast-backwards) the screen to that location. You can scroll the screen to view the history when replay is stopped and resume the replay.

      

+
diff --git a/docs/docs/vm/index.html b/docs/docs/vm/index.html index b02e456..7eb0e24 100644 --- a/docs/docs/vm/index.html +++ b/docs/docs/vm/index.html @@ -10,12 +10,13 @@ By default, the SEED VM uses only NAT-based network, which means that the VM can By default, the SEED VM uses only NAT-based network, which means that the VM can access the Internet but not the host machine (i.e., the machine that runs VirtualBox is called the host, and the VM is often called the guest."> + VirtualBox | WiTTY: Web-based interactive TTY - + @@ -25,7 +26,7 @@ By default, the SEED VM uses only NAT-based network, which means that the VM can
@@ -79,13 +71,18 @@ Use WiTTY with SEED VM img

Then, open the setting for the SEED VM, go to the Network setting, and enable the second adaptor, choose the host-only adaptor. Leave the first adaptor as is.

img

-

After this, start the VM and list all the adaptors using the command ifconfig in a terminal. Look for the adaptor with an IP address starting with 192.168.. You should be able to ssh into the guest using this IP address from the host.

+

After this, start the VM and list all the adaptors using the command ifconfig in a terminal. Look for the adaptor with an IP address starting with 192.168.. You should be able to ssh into the guest using this IP address from the host. Follow the instruction here to install and use WiTTY.

If the host runs Windows, make sure virtualbox host adapter is not disabled in the Windows network settings if VirtualBox cannot find the host-only Ethernet adapter.
+
diff --git a/docs/en.search-data.min.cf01fda4defd8544061a2e23337262b5b8a853e9fa51a19761487bcf875291ac.json b/docs/en.search-data.min.3fdbc2f09c3f796e7eeb937af60ce50fb50da8cd74d7080f3079316ffa006c1b.json similarity index 63% rename from docs/en.search-data.min.cf01fda4defd8544061a2e23337262b5b8a853e9fa51a19761487bcf875291ac.json rename to docs/en.search-data.min.3fdbc2f09c3f796e7eeb937af60ce50fb50da8cd74d7080f3079316ffa006c1b.json index 3d3bdeb..213c55c 100644 --- a/docs/en.search-data.min.cf01fda4defd8544061a2e23337262b5b8a853e9fa51a19761487bcf875291ac.json +++ b/docs/en.search-data.min.3fdbc2f09c3f796e7eeb937af60ce50fb50da8cd74d7080f3079316ffa006c1b.json @@ -1 +1 @@ -[{"id":0,"href":"/docs/install/","title":"Installation","section":"Table of content","content":"Installation # WiTTY runs on Linux (ARM and x86), macOS, and WSL2 (Windows subsystem for Linux, basically Linux). You can install from the pre-built binary or from the source code.\nFrom Binary Visit the release page of WiTTY at https://github.com/syssecfsu/witty/releases\n Download the release for your system\n Decompress the binary with the following command at selected location.\ntar -xzvf witty_vx.x.x_xxx.tar.gz\n For example, use tar -xzvf witty_v1.1.1_linux_amd64.tar.gz to decompress release v1.1.1 for Linux on AMD64.\n From Source Code Install the go compiler. Make sure you have go 1.17 or higher.\n Download the source code release and unzip it, or clone the repo\ngit clone https://github.com/syssecfsu/witty.git\n Go to the root directory of the source code and build the program with\n./build.sh\nThis shell script will build WiTTY and copy the binary with other needed files to the release/ directory. You can move the release/ directory to other places you want. Run WiTTY from this directory.\n macOS users can install go with homebrew. Note that macOS has its own version of golang installed. Do not remove it. Just add the path of newly installed golang at the beginning of the PATH environment variable. WiTTY uses go:embed to embed assets in the binary. Remember to re-build WiTTY after changing templates. Post-installation Configuration # WiTTY uses TLS to protect its traffic. You can request a free Let\u0026rsquo;s Encrypt cert or use a self-signed cert. Here is how to create a self-signed cert in the tls sub-directory:\n# Generate a private key for a curve\nopenssl ecparam -name prime256v1 -genkey -noout -out private-key.pem\n# Create a self-signed certificate\nopenssl req -new -x509 -key private-key.pem -out cert.pem -days 360\n Add a user to the user accounts, follow the instructions on screen to provide the password\n./witty adduser \u0026lt;username\u0026gt;\nWiTTY uses sub-commands for different functions. See details here Start the server and specify the command-line (CLI) program to run when user connects.\n./witty run bash\nIf so desired, you can disable user authenticate with -n/-naked, (not recommended). In the following example, WiTTY will run the ls command without user authentication:\n./witty run -naked ls\n WiTTY normally listens on port 8080. It can be overridden with the -p/-port option: Connect to the server with your browser at port 8080 or the one specified in step 6, for example\nhttps://\u0026lt;witty_server_ip\u0026gt;:8080\n Example Use Case # WiTTY doesn\u0026rsquo;t support Windows because Windows doesn\u0026rsquo;t have PTY. You can still use WiTTY to access Windows terminal through a proxy.\nHere is how to do it. We can run WiTTY on a Raspberry Pi running Raspbian (at address 192.168.1.2). When a user connects via browser to https://192.168.1.2:9000, WiTTY will start a new ssh session to the Windows machine (at address 192.168.1.3) running a SSH server. The command to run WiTTY on the RPI is as follows:\n./witty run -p 9000 ssh 192.168.1.3 -l user_name\nThe user can use any compatible browsers, such as that on a phone, to connect to the Windows machine without install a SSH client.\n mermaid.initialize({ \"flowchart\": { \"useMaxWidth\":true }, \"theme\": \"default\" } ) graph LR A[user on a phone] -- browser -- B[RPI: 192.168.1.1 runs WiTTY] B -- ssh -- C[Windows: 192.168.1.2 runs SSH server ] "},{"id":1,"href":"/docs/ui/","title":"User Interface","section":"Table of content","content":"Sub-commands # Similar to git and apt, WiTTY uses sub-commands for its various functions. WiTTY currently supports the following sub-commands: adduser, deluser, listusers, replay, merge, run.\n Sub-command Description adduser Add/update an authenticated user with their password deluser Delete an authenticated user listusers List all the authenticated users replay Replay a recorded session (set your terminal to 120x36 first) merge Merge several recorded sessions into one session run Run a specified CLI program when user connects with browser Some sub-commands have options. Use -h to find out more. e.g.,\n$ ./witty run -h Usage of run: -n Run WiTTY without user authentication -naked Run WiTTY without user authentication -p uint Port number to listen on (default 8080) -port uint Port number to listen on (default 8080) -w uint Max wait time between outputs (default 1000) -wait uint Max wait time between outputs (default 1000) User Authentication # WiTTY uses username/password based authentication. The user database is stored in user.db under the main directory of WiTTY. The passwords are salted with 64 bytes of random characters and then hashed using SHA256. In addition, passwords must be 12 bytes or longer. WiTTY provides three sub-commands to manage user.db.\n witty adduser \u0026lt;username\u0026gt; witty deluser \u0026lt;username\u0026gt; witty listusers They are pretty self-explanatory. Just follow the instructions on screen.\nWeb Interface (witty run) # The web interface of WiTTY is mostly self-explanatory. After login, the user is presented with the main interface, as shown in this screenshot:\nThere are two tabs that list live and recorded sessions, respectively. You can click New Session to create a new interactive session, which opens in a new browser tab. The main window will list the newly created interactive session similar to the follows:\nWiTTY randomly names an interactive session as its unique ID. You can click the icon of an interactive session to open a read-only view of that session.\nOn the interactive terminal window, you can record an ongoing session by clicking the record button.\nAfter a session has been recorded, the main window\u0026rsquo;s Recorded Sessions will list the records, as shown below. You can replay , download , rename , and delete recorded sessions.\nHere is a screencast where we replay a recorded session that updates the pi-hole system. You can fully control the playback using the progress bar. Clicking on the progress bar stops the replay and fast-forwards (or fast-backwards) the screen to that location. You can scroll the screen to view the history when replay is stopped or resume the replay.\n"},{"id":2,"href":"/docs/record/","title":"Record Sessions","section":"Table of content","content":"Record Sessions # You can record an ongoing session in the interactive terminal window.\nRecorded sessions will be listed in the main window of WiTTY. You can click the button to rename a recorded session. By default, a recorded session is named based on its session ID and the current time, not very meaningful for human. Rename them to something easy to remember, such as task1, task2,\u0026hellip;\nWiTTY provides two sub-commands to merge and replay recorded sessions.\n witty merge -o \u0026lt;output_file\u0026gt; \u0026lt;record1\u0026gt; \u0026lt;record2\u0026gt; ... witty replay -w \u0026lt;wait_time\u0026gt; \u0026lt;recorded_session\u0026gt; Recorded sessions often have long delay between outputs. You can set wait_time of the replay command to limit the maximum wait time between outputs, to speed up the replay.\nThe following screenshot shows how to use witty merge to merge three recorded sessions into alltasks.scr.\nThe intended use of this is to record a separate session for each individual task, rename and merge them into a final session for submission to a project. All the recorded sessions are located under the records directory. "},{"id":3,"href":"/docs/vm/","title":"VirtualBox","section":"Table of content","content":"Use WiTTY with SEED VM # The SEED labs provides a number of security hands-on labs. It is a popular security lab course taught at many universities. The SEED labs use VirtualBox to run its VMs (because VirtualBox is cross-platform.)\nBy default, the SEED VM uses only NAT-based network, which means that the VM can access the Internet but not the host machine (i.e., the machine that runs VirtualBox is called the host, and the VM is often called the guest.) We need to add a second, host-only network adaptor in order to run WiTTY in the guest and access WiTTY from a browser in the host.\nTo do that, first open the Host Network Manager and create a host network if there is not one already, as shown below (on macOS.): Then, open the setting for the SEED VM, go to the Network setting, and enable the second adaptor, choose the host-only adaptor. Leave the first adaptor as is.\nAfter this, start the VM and list all the adaptors using the command ifconfig in a terminal. Look for the adaptor with an IP address starting with 192.168.. You should be able to ssh into the guest using this IP address from the host.\nIf the host runs Windows, make sure virtualbox host adapter is not disabled in the Windows network settings if VirtualBox cannot find the host-only Ethernet adapter. "},{"id":4,"href":"/docs/about/","title":"About","section":"Table of content","content":"About WiTTY # WiTTY is written in the go programming language, using the Gin web framework, gorilla/websocket, pty, and the wonderful xterm.js! The workflow is simple, the client initiates a terminal window (xterm.js) and creates a websocket with the server, which relays the data between pty and xterm.\nThe program has been tested on Linux, WSL2, Raspberry Pi 3B (Debian), and MacOSX using Google Chrome, Firefox, and Safari.\nMost icons were provided by fontawesome under this license.\n"},{"id":5,"href":"/menu/","title":"Index","section":"Introduction","content":" Manual Installation UI Record VM About "}] \ No newline at end of file +[{"id":0,"href":"/docs/install/","title":"Installation","section":"Table of content","content":"Installation # WiTTY runs on Linux (ARM and x86), macOS, and WSL2 (Windows subsystem for Linux, basically Linux). You can install from the pre-built binary or from the source code.\nFrom Binary Visit the release page of WiTTY at https://github.com/syssecfsu/witty/releases\n Download the release for your system\n Decompress the binary with the following command at selected location.\ntar -xzvf witty_vx.x.x_xxx.tar.gz\n For example, use tar -xzvf witty_v1.1.1_linux_amd64.tar.gz to decompress release v1.1.1 for Linux on AMD64.\n From Source Code Install the go compiler. Make sure you have go 1.17 or higher.\n Download the source code release and unzip it, or clone the repo\ngit clone https://github.com/syssecfsu/witty.git\n Go to the root directory of the source code and build the program with\n./build.sh\nThis shell script will build WiTTY and copy the binary with other needed files to the release/ directory. You can move the release/ directory to other places you want. Run WiTTY from this directory.\n macOS users can install go with homebrew. Note that macOS has its own version of golang installed. Do not remove it. Just add the path of newly installed golang at the beginning of the PATH environment variable. WiTTY uses go:embed to embed assets in the binary. Remember to re-build WiTTY after changing templates. Post-installation Configuration # WiTTY uses TLS to protect its traffic. You can request a free Let\u0026rsquo;s Encrypt cert or use a self-signed cert. Here is how to create a self-signed cert in the tls sub-directory:\n# Generate a private key for a curve\nopenssl ecparam -name prime256v1 -genkey -noout -out private-key.pem\n# Create a self-signed certificate\nopenssl req -new -x509 -key private-key.pem -out cert.pem -days 360\n Add a user to the user accounts, follow the instructions on screen to provide the password\n./witty adduser \u0026lt;username\u0026gt;\nWiTTY uses sub-commands for different functions. See details here Start the server and specify the command-line (CLI) program to run when user connects.\n./witty run bash\nIf so desired, you can disable user authenticate with -n/-naked, (not recommended). In the following example, WiTTY will run the ls command without user authentication:\n./witty run -naked ls\n WiTTY normally listens on port 8080. It can be overridden with the -p/-port option: Connect to the server with your browser at port 8080 or the one specified in step 6, for example\nhttps://\u0026lt;witty_server_ip\u0026gt;:8080\n Example Use Case # WiTTY doesn\u0026rsquo;t support Windows because Windows doesn\u0026rsquo;t have PTY. You can still use WiTTY to access Windows terminal through a proxy.\nHere is how to do it. We can run WiTTY on a Raspberry Pi running Raspbian (at address 192.168.1.2). When a user connects via browser to https://192.168.1.2:9000, WiTTY will start a new ssh session to the Windows machine (at address 192.168.1.3) running a SSH server. The command to run WiTTY on the RPI is as follows:\n./witty run -p 9000 ssh 192.168.1.3 -l user_name\nThe user can use any compatible browsers, such as that on a phone, to connect to the Windows machine without install a SSH client.\n mermaid.initialize({ \"flowchart\": { \"useMaxWidth\":true }, \"theme\": \"default\" } ) graph LR A[user on a phone] -- browser -- B[RPI: 192.168.1.2 runs WiTTY] B -- ssh -- C[Windows: 192.168.1.3 runs SSH server ] "},{"id":1,"href":"/docs/ui/","title":"User Interface","section":"Table of content","content":"Sub-commands # Similar to git and apt, WiTTY uses sub-commands for its various functions. WiTTY currently supports the following sub-commands: adduser, deluser, listusers, replay, merge, run.\n Sub-command Description adduser Add/update an authenticated user with their password deluser Delete an authenticated user listusers List all the authenticated users replay Replay a recorded session (set your terminal to 120x36 first) merge Merge several recorded sessions into one session run Run a specified CLI program when user connects with browser Some sub-commands have options. Use -h to find out more. e.g.,\n$ ./witty run -h Usage of run: -n Run WiTTY without user authentication -naked Run WiTTY without user authentication -p uint Port number to listen on (default 8080) -port uint Port number to listen on (default 8080) -w uint Max wait time between outputs (default 1000) -wait uint Max wait time between outputs (default 1000) User Authentication # WiTTY uses username/password based authentication. The user database is stored in user.db under the main directory of WiTTY. The passwords are salted with 64 bytes of random characters and then hashed using SHA256. In addition, passwords must be 12 bytes or longer. WiTTY provides three sub-commands to manage user.db.\n witty adduser \u0026lt;username\u0026gt; witty deluser \u0026lt;username\u0026gt; witty listusers They are pretty self-explanatory. Just follow the instructions on screen.\nWeb Interface (witty run) # The web interface of WiTTY is mostly self-explanatory. After login, the user is presented with the main interface, as shown in this screenshot:\nThere are two tabs that list live and recorded sessions, respectively. You can click New Session to create a new interactive session, which opens in a new browser tab. The main window will list the newly created interactive session similar to the follows:\nWiTTY randomly names an interactive session as its unique ID. You can click the icon of an interactive session to open a read-only view of that session.\nOn the interactive terminal window, you can record an ongoing session by clicking the record button.\nAfter a session has been recorded, the main window\u0026rsquo;s Recorded Sessions will list the records, as shown below. You can replay , download , rename , and delete recorded sessions.\nHere is a screencast where we replay a recorded session that updates the pi-hole system. You can fully control the playback using the progress bar. Clicking on the progress bar stops the replay and fast-forwards (or fast-backwards) the screen to that location. You can scroll the screen to view the history when replay is stopped and resume the replay.\n"},{"id":2,"href":"/docs/record/","title":"Record Sessions","section":"Table of content","content":"Record Sessions # You can record an ongoing session in the interactive terminal window.\nRecorded sessions will be listed in the main window of WiTTY. You can click the button to rename a recorded session. By default, a recorded session is named based on its session ID and the current time, not very meaningful for human. Rename them to something easy to remember, such as task1, task2,\u0026hellip;\nWiTTY provides two sub-commands to merge and replay recorded sessions.\n witty merge -o \u0026lt;output_file\u0026gt; \u0026lt;record1\u0026gt; \u0026lt;record2\u0026gt; ... witty replay -w \u0026lt;wait_time\u0026gt; \u0026lt;recorded_session\u0026gt; Recorded sessions often have long delay between outputs. You can set wait_time of the replay command to limit the maximum wait time between outputs, to speed up the replay.\nThe following screenshot shows how to use witty merge to merge three recorded sessions into alltasks.scr.\nThe intended use of this is to record a separate session for each individual task, rename and merge them into a final session for submission to a project. All the recorded sessions are located under the records directory. "},{"id":3,"href":"/docs/vm/","title":"VirtualBox","section":"Table of content","content":"Use WiTTY with SEED VM # The SEED labs provides a number of security hands-on labs. It is a popular security lab course taught at many universities. The SEED labs use VirtualBox to run its VMs (because VirtualBox is cross-platform.)\nBy default, the SEED VM uses only NAT-based network, which means that the VM can access the Internet but not the host machine (i.e., the machine that runs VirtualBox is called the host, and the VM is often called the guest.) We need to add a second, host-only network adaptor in order to run WiTTY in the guest and access WiTTY from a browser in the host.\nTo do that, first open the Host Network Manager and create a host network if there is not one already, as shown below (on macOS.): Then, open the setting for the SEED VM, go to the Network setting, and enable the second adaptor, choose the host-only adaptor. Leave the first adaptor as is.\nAfter this, start the VM and list all the adaptors using the command ifconfig in a terminal. Look for the adaptor with an IP address starting with 192.168.. You should be able to ssh into the guest using this IP address from the host. Follow the instruction here to install and use WiTTY.\nIf the host runs Windows, make sure virtualbox host adapter is not disabled in the Windows network settings if VirtualBox cannot find the host-only Ethernet adapter. "},{"id":4,"href":"/docs/about/","title":"About","section":"Table of content","content":"About WiTTY # WiTTY is written in the go programming language, using the Gin web framework, gorilla/websocket, pty, and the wonderful xterm.js! The workflow is simple, the client initiates a terminal window (xterm.js) and creates a websocket with the server, which relays the data between pty and xterm.\nThe program has been tested on Linux, WSL2, Raspberry Pi 3B (Debian), and MacOSX using Google Chrome, Firefox, and Safari.\nMost icons were provided by fontawesome under this license.\n"},{"id":5,"href":"/menu/","title":"Index","section":"Introduction","content":" Installation User Interface Record Sessions VirtualBox About "}] \ No newline at end of file diff --git a/docs/en.search.min.d94cd9e9271fd6c7ba798461e1fbda7c357c43fe43568c26463af5c34e1cc416.js b/docs/en.search.min.28bcb0d34997b542e09ca609614fe8df7743a461230c57511923615abac30b55.js similarity index 87% rename from docs/en.search.min.d94cd9e9271fd6c7ba798461e1fbda7c357c43fe43568c26463af5c34e1cc416.js rename to docs/en.search.min.28bcb0d34997b542e09ca609614fe8df7743a461230c57511923615abac30b55.js index 628526a..2f0b249 100644 --- a/docs/en.search.min.d94cd9e9271fd6c7ba798461e1fbda7c357c43fe43568c26463af5c34e1cc416.js +++ b/docs/en.search.min.28bcb0d34997b542e09ca609614fe8df7743a461230c57511923615abac30b55.js @@ -1 +1 @@ -'use strict';(function(){const g='/en.search-data.min.cf01fda4defd8544061a2e23337262b5b8a853e9fa51a19761487bcf875291ac.json',h=Object.assign({cache:!0},{doc:{id:'id',field:['title','content'],store:['title','href','section']}}),a=document.querySelector('#book-search-input'),b=document.querySelector('#book-search-results');if(!a)return;a.addEventListener('focus',c),a.addEventListener('keyup',d),document.addEventListener('keypress',e);function e(b){if(b.target.value!==void 0)return;if(a===document.activeElement)return;const c=String.fromCharCode(b.charCode);if(!f(c))return;a.focus(),b.preventDefault()}function f(b){const c=a.getAttribute('data-hotkeys')||'';return c.indexOf(b)>=0}function c(){a.removeEventListener('focus',c),a.required=!0,fetch(g).then(a=>a.json()).then(a=>{window.bookSearchIndex=FlexSearch.create('balance',h),window.bookSearchIndex.add(a)}).then(()=>a.required=!1).then(d)}function d(){while(b.firstChild)b.removeChild(b.firstChild);if(!a.value)return;const c=window.bookSearchIndex.search(a.value,10);c.forEach(function(a){const c=i('
    • '),d=c.querySelector('a'),e=c.querySelector('small');d.href=a.href,d.textContent=a.title,e.textContent=a.section,b.appendChild(c)})}function i(b){const a=document.createElement('div');return a.innerHTML=b,a.firstChild}})() \ No newline at end of file +'use strict';(function(){const g='/en.search-data.min.3fdbc2f09c3f796e7eeb937af60ce50fb50da8cd74d7080f3079316ffa006c1b.json',h=Object.assign({cache:!0},{doc:{id:'id',field:['title','content'],store:['title','href','section']}}),a=document.querySelector('#book-search-input'),b=document.querySelector('#book-search-results');if(!a)return;a.addEventListener('focus',c),a.addEventListener('keyup',d),document.addEventListener('keypress',e);function e(b){if(b.target.value!==void 0)return;if(a===document.activeElement)return;const c=String.fromCharCode(b.charCode);if(!f(c))return;a.focus(),b.preventDefault()}function f(b){const c=a.getAttribute('data-hotkeys')||'';return c.indexOf(b)>=0}function c(){a.removeEventListener('focus',c),a.required=!0,fetch(g).then(a=>a.json()).then(a=>{window.bookSearchIndex=FlexSearch.create('balance',h),window.bookSearchIndex.add(a)}).then(()=>a.required=!1).then(d)}function d(){while(b.firstChild)b.removeChild(b.firstChild);if(!a.value)return;const c=window.bookSearchIndex.search(a.value,10);c.forEach(function(a){const c=i('
    • '),d=c.querySelector('a'),e=c.querySelector('small');d.href=a.href,d.textContent=a.title,e.textContent=a.section,b.appendChild(c)})}function i(b){const a=document.createElement('div');return a.innerHTML=b,a.firstChild}})() \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 2ddf708..c13e21b 100644 --- a/docs/index.html +++ b/docs/index.html @@ -15,7 +15,7 @@ - + @@ -26,7 +26,7 @@
    @@ -74,7 +65,7 @@ Introduction # -

    WiTTY is a cross-platform, open-source, web-based terminal emulator. It exports the terminal interface on the server (i.e., where WiTTY runs) to the browser. Simply run WiTTY on a computer and give it the command to execute when users connect via the browser. WiTTY has the following features that distinguish itself from other similar tools:

    +

    WiTTY is a cross-platform, open-source, web-based terminal emulator. It exports the terminal interface on the server (i.e., where WiTTY runs) to the browser. Simply run WiTTY on a computer and give it the command to execute when users connect via the browser. WiTTY has the following features that distinguish itself from other similar tools:

    1. WiTTY allows users to easily record, replay, and share console sessions with just a few clicks.

      @@ -99,6 +90,11 @@ Instructors can also record their demos in WiTTY and send them to students. Stud
      +
      diff --git a/docs/index.xml b/docs/index.xml index 10a4bba..28d9446 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -9,4 +9,4 @@ Recorded sessions will be listed in the main window of WiTTY. You can click the WiTTY provides two sub-commands to merge and replay recorded sessions.VirtualBoxhttps://syssecfsu.github.io/witty/docs/vm/Mon, 01 Jan 0001 00:00:00 +0000https://syssecfsu.github.io/witty/docs/vm/Use WiTTY with SEED VM # The SEED labs provides a number of security hands-on labs. It is a popular security lab course taught at many universities. The SEED labs use VirtualBox to run its VMs (because VirtualBox is cross-platform.) By default, the SEED VM uses only NAT-based network, which means that the VM can access the Internet but not the host machine (i.e., the machine that runs VirtualBox is called the host, and the VM is often called the guest.Abouthttps://syssecfsu.github.io/witty/docs/about/Mon, 01 Jan 0001 00:00:00 +0000https://syssecfsu.github.io/witty/docs/about/About WiTTY # WiTTY is written in the go programming language, using the Gin web framework, gorilla/websocket, pty, and the wonderful xterm.js! The workflow is simple, the client initiates a terminal window (xterm.js) and creates a websocket with the server, which relays the data between pty and xterm. The program has been tested on Linux, WSL2, Raspberry Pi 3B (Debian), and MacOSX using Google Chrome, Firefox, and Safari. -Most icons were provided by fontawesome under this license.<link>https://syssecfsu.github.io/witty/menu/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://syssecfsu.github.io/witty/menu/</guid><description> Manual Installation UI Record VM About</description></item></channel></rss> \ No newline at end of file +Most icons were provided by fontawesome under this license.</description></item><item><title/><link>https://syssecfsu.github.io/witty/menu/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://syssecfsu.github.io/witty/menu/</guid><description> Installation User Interface Record Sessions VirtualBox About</description></item></channel></rss> \ No newline at end of file diff --git a/docs/menu/index.html b/docs/menu/index.html index 9c186d5..0db2e56 100644 --- a/docs/menu/index.html +++ b/docs/menu/index.html @@ -2,18 +2,19 @@ <head> <meta charset=utf-8> <meta name=viewport content="width=device-width,initial-scale=1"> -<meta name=description content=" Manual Installation UI Record VM About "> +<meta name=description content=" Installation User Interface Record Sessions VirtualBox About "> <meta name=theme-color content="#FFFFFF"> <meta name=color-scheme content="light dark"><meta property="og:title" content> -<meta property="og:description" content=" Manual Installation UI Record VM About "> +<meta property="og:description" content=" Installation User Interface Record Sessions VirtualBox About "> <meta property="og:type" content="article"> <meta property="og:url" content="https://syssecfsu.github.io/witty/menu/"><meta property="article:section" content> +<meta property="article:modified_time" content="2022-02-06T13:48:21-05:00"> <title>Index | WiTTY: Web-based interactive TTY - + @@ -23,7 +24,7 @@
      @@ -68,17 +60,21 @@
      +
      diff --git a/docs/sitemap.xml b/docs/sitemap.xml index 849aed8..0eccf8c 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -1 +1 @@ -https://syssecfsu.github.io/witty/docs/install/https://syssecfsu.github.io/witty/docs/https://syssecfsu.github.io/witty/docs/ui/https://syssecfsu.github.io/witty/docs/record/https://syssecfsu.github.io/witty/docs/vm/https://syssecfsu.github.io/witty/docs/about/https://syssecfsu.github.io/witty/menu/https://syssecfsu.github.io/witty/categories/https://syssecfsu.github.io/witty/https://syssecfsu.github.io/witty/tags/ \ No newline at end of file +https://syssecfsu.github.io/witty/docs/install/2022-02-06T20:15:40-05:00https://syssecfsu.github.io/witty/docs/2022-02-06T13:48:21-05:00https://syssecfsu.github.io/witty/docs/ui/2022-02-06T20:15:40-05:00https://syssecfsu.github.io/witty/docs/record/2022-02-06T13:48:21-05:00https://syssecfsu.github.io/witty/docs/vm/2022-02-06T20:15:40-05:00https://syssecfsu.github.io/witty/docs/about/2022-02-06T20:15:40-05:00https://syssecfsu.github.io/witty/menu/2022-02-06T13:48:21-05:00https://syssecfsu.github.io/witty/categories/https://syssecfsu.github.io/witty/2022-02-06T13:48:21-05:00https://syssecfsu.github.io/witty/tags/ \ No newline at end of file diff --git a/docs/tags/index.html b/docs/tags/index.html index 9d087bc..e940240 100644 --- a/docs/tags/index.html +++ b/docs/tags/index.html @@ -13,7 +13,7 @@ - + @@ -24,7 +24,7 @@