warp-tech/warpgate
1
1
Fork 0
mirror of https://github.com/warp-tech/warpgate.git synced 2024-09-20 06:46:17 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
Eugene Pankov 2022-07-27 00:45:28 +02:00
parent 5891775619
commit 8b436db290
No known key found for this signature in database
GPG key ID: 5896FCBBDD1CF4F4
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -8,10 +8,10 @@
--- ---
Warpgate is a smart SSH & HTTPS bastion host for Linux that can be used with _any_ SSH client. Warpgate is a smart SSH, HTTPS and MySQL bastion host for Linux that doesn't need special client apps.
* Set it up in your DMZ, add user accounts and easily assign them to specific hosts and URLs within the network. * Set it up in your DMZ, add user accounts and easily assign them to specific hosts and URLs within the network.
* Warpgate will record every SSH session for you to view (live) and replay later through a built-in admin web UI. * Warpgate will record every session for you to view (live) and replay later through a built-in admin web UI.
* Not a jump host - forwards your connections straight to the target instead. * Not a jump host - forwards your connections straight to the target instead.
* 2FA support * 2FA support
* Single binary with no dependencies. * Single binary with no dependencies.
@ -46,17 +46,17 @@ The project is currently in **alpha** stage and is gathering community feedback.
In particular, we're working on: In particular, we're working on:
* Support for tunneling database connections, * Requesting admin approvals for sessions
* Requesting admin approval for sessions * Support for tunneling PostgreSQL connections,
* and much more. * and much more.
## How it works ## How it works
Warpgate is a service that you deploy on the bastion/DMZ host, which will accept SSH and HTTPS connections and provide an (optional) web admin UI. Warpgate is a service that you deploy on the bastion/DMZ host, which will accept SSH, HTTPS and MySQL connections and provide an (optional) web admin UI.
Run `warpgate setup` to interactively generate a config file, including port bindings. See [Getting started](https://github.com/warp-tech/warpgate/wiki/Getting-started) for details. Run `warpgate setup` to interactively generate a config file, including port bindings. See [Getting started](https://github.com/warp-tech/warpgate/wiki/Getting-started) for details.
It receives SSH connections with specifically formatted credentials, authenticates the user locally, connects to the target itself, and then connects both parties together while (optionally) recording the session. It receives connections with specifically formatted credentials, authenticates the user locally, connects to the target itself, and then connects both parties together while (optionally) recording the session.
When connecting through HTTPS, Warpgate presents a selection of available targets, and will then proxy all traffic in a session to the selected target. You can switch between targets at any time. When connecting through HTTPS, Warpgate presents a selection of available targets, and will then proxy all traffic in a session to the selected target. You can switch between targets at any time.