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

Update README.md

Browse Source
This commit is contained in:
Tweak
2022-02-01 21:56:21 -07:00
committed by GitHub
parent b8a2b4d387
commit 55da265732
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -15,14 +15,14 @@ compatible (standard) web browser.
Compiled binaries can be found at the [release] section of the page.
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 own
risk.
[release]: https://github.com/nirui/sshwifty/releases
### 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:
```
@@ -49,7 +49,7 @@ $ docker run --detach \
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
upon.
@@ -57,7 +57,7 @@ upon.
### 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
- `node` and `npm` to build front-end application
@@ -72,11 +72,11 @@ $ npm install
$ 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.
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
@@ -316,13 +316,13 @@ SSHWIFTY_PRESETS
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.
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
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
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.
_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.
(Notice: Typo, grammar error or invalid use of language in the source code and