From 1508e055f6f6be00ed6b1545b24d173708f67143 Mon Sep 17 00:00:00 2001 From: Sheng Date: Mon, 26 Feb 2018 08:08:15 +0800 Subject: [PATCH] Updated README.md --- README.md | 34 +++++++++++++++------------------- 1 file changed, 15 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 39a0443..3b1ce33 100644 --- a/README.md +++ b/README.md @@ -13,32 +13,28 @@ A simple web application to be used as an ssh client to connect to your ssh serv * Terminal window resizable. * Compatible with Python 2.7-3.6. -### Install dependencies +### Instructions ``` -$ pip install -r requirements.txt +git clone https://github.com/huashengdun/webssh.git +cd webssh +pip install -r requirements.txt +python main.py ``` -### Run - +### Options ``` -// default listen on 127.0.0.1:8888 -$ python main.py +# configure listen address and port +python main.py --address='0.0.0.0' --port=8000 -// change listen address and port -$ python main.py --address='0.0.0.0' --port=8000 +# configure logging level +python main.py --logging=debug -// change logging level -$ python main.py --logging=debug +# log to file +python main.py --log-file-prefix=main.log -// log to file -$ python main.py --log-file-prefix=main.log -``` - -### Help - -``` -$ python main.py --help -``` +# more options +python main.py --help +``````` ### Nginx config example for running this app behind an nginx server ```