Merge pull request #74 from Tweak4141/master
Updated grammar and fixed spelling in README, as well as fixed spelling and grammar in the controller file.
This commit is contained in:
20
README.md
20
README.md
@@ -14,15 +14,15 @@ 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 advised that those binaries is generated by an automatic proccess,
|
Please be advised that those binaries are 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 that they work. You will have to try it at your own
|
||||||
risk.
|
risk.
|
||||||
|
|
||||||
[release]: https://github.com/nirui/sshwifty/releases
|
[release]: https://github.com/nirui/sshwifty/releases
|
||||||
|
|
||||||
### Docker Image
|
### Docker Image
|
||||||
|
|
||||||
If [Docker] is installed on your machine, you may use our prebuild Docker Image
|
If [Docker] is installed on your machine, you may use our prebuilt Docker Image
|
||||||
by executing following command:
|
by executing following command:
|
||||||
|
|
||||||
```
|
```
|
||||||
@@ -49,7 +49,7 @@ $ docker run --detach \
|
|||||||
niruix/sshwifty:latest
|
niruix/sshwifty:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
The `domain.crt` and `domain.key` must be valid TLS certificate and key file
|
The `domain.crt` and `domain.key` must be a valid TLS certificate and key file
|
||||||
located on the same machine which the `docker run` command will be executed
|
located on the same machine which the `docker run` command will be executed
|
||||||
upon.
|
upon.
|
||||||
|
|
||||||
@@ -57,7 +57,7 @@ upon.
|
|||||||
|
|
||||||
### Compile from source code (Recommanded if you're a developer)
|
### Compile from source code (Recommanded if you're a developer)
|
||||||
|
|
||||||
Following tools is required in order to build the software from source code:
|
The following tools are required in order to build the software from source code:
|
||||||
|
|
||||||
- `git` to download the source code
|
- `git` to download the source code
|
||||||
- `node` and `npm` to build front-end application
|
- `node` and `npm` to build front-end application
|
||||||
@@ -72,11 +72,11 @@ $ npm install
|
|||||||
$ npm run build
|
$ npm run build
|
||||||
```
|
```
|
||||||
|
|
||||||
When done, you can found the newly generated `sshwifty` binary inside current
|
When done, you can found the newly generated `sshwifty` binary inside the current
|
||||||
working directory.
|
working directory.
|
||||||
|
|
||||||
Notice: `Dockerfile` contains the entire build procedure of this software.
|
Notice: `Dockerfile` contains the entire build procedure of this software.
|
||||||
Please refer to it when you encountered any compile/build related issue.
|
Please refer to it when you encounter any compile/build related issue.
|
||||||
|
|
||||||
### Deploy on the cloud
|
### Deploy on the cloud
|
||||||
|
|
||||||
@@ -316,13 +316,13 @@ SSHWIFTY_PRESETS
|
|||||||
SSHWIFTY_ONLYALLOWPRESETREMOTES
|
SSHWIFTY_ONLYALLOWPRESETREMOTES
|
||||||
```
|
```
|
||||||
|
|
||||||
The option they represented is corresponded to their counterparts in the
|
The options they represent correspond to their counterparts in the
|
||||||
configuration file.
|
configuration file.
|
||||||
|
|
||||||
Notice: When you're using environment variables to configure Sshwifty, only one
|
Notice: When you're using environment variables to configure Sshwifty, only one
|
||||||
Sshwifty HTTP server is then allowed. There is no way to setup mulitple servers
|
Sshwifty HTTP server is then allowed. There is no way to setup mulitple servers
|
||||||
under this method of configuration. If you need to serve on multiple ports, use
|
under this method of configuration. If you need to serve on multiple ports, use
|
||||||
configuration file instead.
|
the configuration file instead.
|
||||||
|
|
||||||
Be aware: An invalid value inside following environment variables will cause
|
Be aware: An invalid value inside following environment variables will cause
|
||||||
the value to be sliently reset to default during configuration parsing phase
|
the value to be sliently reset to default during configuration parsing phase
|
||||||
@@ -407,7 +407,7 @@ Upon release (Which is then you're able to read this file), this project will
|
|||||||
enter _maintaining_ state, which includes doing bug fix and security updates.
|
enter _maintaining_ state, which includes doing bug fix and security updates.
|
||||||
_Adding new features however, is not a part of the state_.
|
_Adding new features however, is not a part of the state_.
|
||||||
|
|
||||||
Please do not send pull request. If you need new feature, fork it, add it by
|
Please do not send any pull requests. If you need new feature, fork it, add it by
|
||||||
yourself, and maintain it like one of your own project.
|
yourself, and maintain it like one of your own project.
|
||||||
|
|
||||||
(Notice: Typo, grammar error or invalid use of language in the source code and
|
(Notice: Typo, grammar error or invalid use of language in the source code and
|
||||||
|
|||||||
@@ -63,7 +63,7 @@ func (h handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
|||||||
|
|
||||||
if h.commonCfg.HostName != hostPort &&
|
if h.commonCfg.HostName != hostPort &&
|
||||||
!strings.HasPrefix(hostPort, h.hostNameChecker) {
|
!strings.HasPrefix(hostPort, h.hostNameChecker) {
|
||||||
clientLogger.Warning("Request invalid host \"%s\", deined",
|
clientLogger.Warning("Requested invalid host \"%s\", denied access",
|
||||||
r.Host)
|
r.Host)
|
||||||
|
|
||||||
serveFailure(
|
serveFailure(
|
||||||
|
|||||||
Reference in New Issue
Block a user