From 772907fab1334d3bcb9ca11dc0649fe5ab9d81a2 Mon Sep 17 00:00:00 2001 From: Bill Church Date: Mon, 17 May 2021 06:55:35 -0400 Subject: [PATCH] docs: update docs for 0.4.0 #242 --- ChangeLog.md | 7 +++++++ README.md | 8 +++++++- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/ChangeLog.md b/ChangeLog.md index 3d130099..ec9c1f3f 100644 --- a/ChangeLog.md +++ b/ChangeLog.md @@ -1,4 +1,11 @@ # Change Log +## 0.4.0 [TBD] +### BREAKING +- Disabled ssh.serverlog.client option, this disables the POC which allowed for logging of the data sent between the client/server to the console.log. Code still exists but is commented out in roughly lines 103-116 of ./app/server/socket.js +### CONTRIBUTING +In this release, we're trying our best to conform to the [Airbnb Javascript Style Guide](https://airbnb.io/projects/javascript/). I'm hoping this will make contributions easier and keep the code readable. I love shortcuts more than anyone but I've found when making changes to code I've not looked at in a while, it can take me a few momements to deconstruct what was being done due to readbility issues. While I don't agree with every decision in the style guide (semi-colons, yuk), it is a good base to keep the code consistent. + +If you've not used it before, I recommend installing the [vscode extensions](https://blog.echobind.com/integrating-prettier-eslint-airbnb-style-guide-in-vscode-47f07b5d7d6a) for that and [Prettier](https://prettier.io/) and getting familiar. The autocorrections are great (especially if you hate dealing with semi-colons...) ## 0.3.1 [20210513] ### BREAKING - Ability to configure CORS settings for socket.io see [#240](../../issues/240) for more information on how this may break existing deployments. Default settings in example `config.json` are currently permissive `http.origins: ["*:*"]` please note that if a `config.json` is not present, the default is `http.origins: ["localhost:2222"] diff --git a/README.md b/README.md index d04599ff..9f80e739 100644 --- a/README.md +++ b/README.md @@ -239,7 +239,7 @@ docker run --name webssh2 -d -p 2222:2222 -v `pwd`/app/config.json:/usr/src/conf * **safeShutdownDuration** - _integer_ - maximum delay, in seconds, given to users before the server stops when doing a safe shutdown -# Experimental client-side logging +# Client-side logging Clicking `Start logging` on the status bar will log all data to the client. A `Download log` option will appear after starting the logging. You may download at any time to the client. You may stop logging at any time my pressing the `Logging - STOP LOG`. Note that clicking the `Start logging` option again will cause the current log to be overwritten, so be sure to download first. # Example: @@ -248,3 +248,9 @@ http://localhost:2222/ssh/host/192.168.1.1?port=2244&header=My%20Header&headerBa # Tips * If you want to add custom JavaScript to the browser client you can either modify `./src/client.html` and add a **