Updated README.md

pull/12/head
Sheng 2018-02-26 08:08:15 +08:00
parent d817f81b38
commit 1508e055f6
1 changed files with 15 additions and 19 deletions

View File

@ -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
```