Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ZStrikeGit authored and nirui committed Oct 8, 2024
1 parent 819149a commit 508fb01
Showing 1 changed file with 16 additions and 14 deletions.
30 changes: 16 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,26 +18,26 @@ glare, while the rest showed a little interest)
### Prebuilt Executables

We offer prebuilt ready-to-run programs (called executables) for a handful of
popular platforms in the [release] section. You might find one built for your
popular platforms in the [Releases] section. You might find one built for your
platform there.

Please aware that these executables are generated by an unsupervised automatic
procedure, and we (as the authors and contributors) cannot guarantee to test
them. If you've encountered unusual failure caused by those executables, feel
free to open an issue, so we can take a look.

[release]: https://github.com/nirui/sshwifty/releases
[releases]: https://github.com/nirui/sshwifty/releases

### Docker Image (recommended)

Deploying Sshwifty as a Docker container allows you to isolate Sshwifty from the
Deploying Sshwifty as a [Docker] container allows you to isolate Sshwifty from the
rest of the system for better system organization and security.

We also offer prebuilt Docker Images for few selected platforms generated in the
same way as we generate the prebuilt Executables described above. To deploy one
on your Docker host, run:

```
```shell
$ docker run --detach \
--restart always \
--publish 8182:8182 \
Expand All @@ -61,7 +61,7 @@ When TLS is desired and you don't want to setup Docker Volumes, you can use
`SSHWIFTY_DOCKER_TLSCERT` and `SSHWIFTY_DOCKER_TLSCERTKEY` environment variables
to import certificate files to the container and automatically apply them:

```
```shell
$ openssl req \
-newkey rsa:4096 -nodes -keyout domain.key -x509 -days 90 -out domain.crt
$ docker run --detach \
Expand All @@ -77,10 +77,12 @@ The `domain.crt` and `domain.key` in the command above is the location of valid
X509 certificate and key file.

Though, in most situations where a reverse proxy and/or load balancer (for
example, Nginx or Traefik) is used in front of Sshwifty instances, TLS should
example, [Nginx] or [Traefik]) is used in front of Sshwifty instances, TLS should
usually terminate on the proxy, not on the individual Sshwifty instances.

[docker]: https://www.docker.com
[nginx]: https://github.com/nginx/nginx
[traefik]: https://github.com/traefik/traefik

### Compile from source code (recommended for developers)

Expand All @@ -93,7 +95,7 @@ code:

To start the build process, run:

```
```shell
$ git clone https://github.com/nirui/sshwifty
$ cd sshwifty
$ npm install
Expand All @@ -106,7 +108,7 @@ working directory.
Notice: `Dockerfile` contains the entire build procedure of this software.
Please refer to it when you encounter any compile/build related issue.

### Third-party Homebrew Formulae from @unbeatable-101
### Third-party Homebrew Formulae from [@unbeatable-101]

If you're a macOS user, [@unbeatable-101] is kindly hosting a Homebrew
Formulae that allows you to install his custom Sshwifty builds for macOS via
Expand All @@ -116,9 +118,9 @@ instruction and contribute to his work.
Please note that, due to the third-party nature of the work, the author(s) of
Sshwifty are unable to provide any audit, warranty or support for it. If you
have any question or request regarding to the Formulae, please contact
@unbeatable-101 directly through appreciate channels.
[@unbeatable-101] directly through appreciate channels.

Thank @unbeatable-101 for his work.
Thank [@unbeatable-101] for his work.

[@unbeatable-101]: https://github.com/unbeatable-101
[unbeatable-101/homebrew-sshwifty]: https://github.com/unbeatable-101/homebrew-sshwifty
Expand All @@ -132,7 +134,7 @@ first, when all failed, environment variables will be used.
You can also specify your own configuration file with `SSHWIFTY_CONFIG`
environment variable. For example:

```
```shell
$ SSHWIFTY_CONFIG=./sshwifty.conf.json ./sshwifty
```

Expand All @@ -142,7 +144,7 @@ This tells Sshwifty to only load configuration from file `./sshwifty.conf.json`.

Here is all the options of the configuration file:

```
```json
{
// HTTP Host. Keep it empty to accept request from all hosts, otherwise, only
// specified host is allowed to access
Expand Down Expand Up @@ -414,7 +416,7 @@ always located under an URL prefix `/sshwifty`. You can thus redirect or proxy
those requests to their new location.

Keep in mind, doing so is really hacky, and it's not recommended by the author
thus no support will be provided if you decide to go with that.
thus no support will be provided if you decide to do so.

### Why I can't add my own key combinations to the Console tool bar?

Expand Down Expand Up @@ -459,6 +461,6 @@ by yourself, then maintain it like one of your own project. It's not that hard
with some Github features.

(Notice: Typos, grammar errors or invalid use of language in the source code and
document is categorized as bug, please report them if you found any. Thank you!)
documentation should be catagorized as a bug, please report them if you find any. Thank you!)

Appreciate your help, enjoy!

0 comments on commit 508fb01

Please sign in to comment.