idan/sshwifty-udp-telnet-http
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix typo and wording

Browse Source
This commit is contained in:
NI
2019-09-27 08:22:17 +08:00
parent 9e825542ad
commit 512e410221
1 changed files with 26 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@@ -1,7 +1,7 @@
# Sshwifty Web SSH Client # Sshwifty Web SSH & Telnet Client
Sshwifty is a SSH client that provides a web interface. It can be deployed on **Sshwifty is a SSH and Telnet connector made for Web.** It can be deployed on
your computer or server, so you can access SSH servers via any device with a your computer or server to provide SSH and Telnet access interface to any
compatible (standard) web browser. compatible (standard) web browser.
![Web Interface](Screenshot.png) ![Web Interface](Screenshot.png)
@@ -14,7 +14,7 @@ compatible (standard) web browser.
Compiled binaries can be found at the [release] section of the page. Compiled binaries can be found at the [release] section of the page.
Please be noted that those binaries was generated by an automatic proccess, and Please be advised that those binaries is generated by an automatic proccess,
the author of this project will NOT verify them. You have to try it at your owk the author of this project will NOT verify them. You have to try it at your owk
risk. risk.
@@ -22,8 +22,8 @@ risk.
### Docker Image ### Docker Image
If [Docker] is installed on your machine, then you can use our Docker image by If [Docker] is installed on your machine, you may use our prebuild Docker Image
executing following command: by executing following command:
``` ```
$ docker run --detach \ $ docker run --detach \
@@ -33,9 +33,9 @@ $ docker run --detach \
niruix/sshwifty:latest niruix/sshwifty:latest
``` ```
If you want to use TLS (HTTPS) with the Docker image and don't want to setup When TLS is desired and you don't want to setup Docker Volumes, you can use
volumes, you can use `SSHWIFTY_DOCKER_TLSCERT` and `SSHWIFTY_DOCKER_TLSCERTKEY` `SSHWIFTY_DOCKER_TLSCERT` and `SSHWIFTY_DOCKER_TLSCERTKEY` environment variables
environment variables when starting the container: to import credential files to the container and automatically apply them:
``` ```
$ openssl req \ $ openssl req \
@@ -56,14 +56,13 @@ located on the machine which the `docker run` command will be executed.
### Compile from source code (Recommanded if you're a developer) ### Compile from source code (Recommanded if you're a developer)
In order to use the source code, you need to install following tools: Following tools is required in order to build the software from source code:
- `git` to download the source code - `git` to download the source code
- `npm` to compile front-end application - `node` and `npm` to build front-end application
- `go` to compile back-end application - `go` to build back-end application
After installing those tools, run following command to download the code to your To start the build process, execute:
computer, and start the build proccess:
``` ```
$ git clone https://github.com/niruix/sshwifty $ git clone https://github.com/niruix/sshwifty
@@ -72,9 +71,12 @@ $ npm install
$ npm run build $ npm run build
``` ```
If succeed, you will found the newly generated `sshwifty` binary under current When done, you can found the newly generated `sshwifty` binary inside current
working directory. working directory.
Notice: `Dockerfile` contains the entire build procedure of this software.
Please refer to it when you encountered any compile/build related problem.
### Deploy on the cloud ### Deploy on the cloud
To deploy this project onto the cloud, Google App Engine or Heroku for example, To deploy this project onto the cloud, Google App Engine or Heroku for example,
@@ -83,16 +85,19 @@ deploying it.
`npm run generate` command will generate all static files and automatically `npm run generate` command will generate all static files and automatically
call `go generate ./...` to bind those static files directly into program source call `go generate ./...` to bind those static files directly into program source
code. You need those generated source code to get application to function. code. And you need those generated source code to get the software to function.
Trying to deploy ungenerated code directly to cloud will lead to failure, as Trying to deploy ungenerated code directly to cloud will lead to failure, as
required source code is missing. required source code is missing.
Also keep in mind, if the cloud deployment process is `git` based, you may have
to modify `.gitignore` file in order to allow all required files to be uploaded.
## Configure ## Configure
Sshwifty can be configured though either file or environment variables. By Sshwifty can be configured through either file or environment variables. By
default, the configuration loader will try to load file from default paths default, the configuration loader will try to load file from default paths
first, then try environment variables. first, when failed, environment variables will be used.
You can also specify your own configuration file by setting `SSHWIFTY_CONFIG` You can also specify your own configuration file by setting `SSHWIFTY_CONFIG`
environment variable. For example: environment variable. For example:
@@ -101,8 +106,8 @@ environment variable. For example:
$ SSHWIFTY_CONFIG=./sshwifty.conf.json ./sshwifty $ SSHWIFTY_CONFIG=./sshwifty.conf.json ./sshwifty
``` ```
After that, Sshwifty will try to load the configuration from file This way, Sshwifty will try to load the configuration from file
`./sshwifty.conf.json`, and will never reach for other environment variables. `./sshwifty.conf.json`, and never reach for other environment variables.
### Configuration file ### Configuration file
@@ -246,7 +251,7 @@ time on both the client and the server with a trusted time server.
### Why I got error "TypeError: Cannot read property 'importKey' of undefined" ### Why I got error "TypeError: Cannot read property 'importKey' of undefined"
It's usually because your web browser is not support WebCrypt API, or the It's usually because your web browser does not support WebCrypt API, or the
support has been disabled. support has been disabled.
If you're using Google Chrome, please use HTTPS when connect to Sshwifty. Chrome If you're using Google Chrome, please use HTTPS when connect to Sshwifty. Chrome