warpgate/README.md
Eugene Pankov 4ccf2b0437
import
2022-04-10 22:58:58 +02:00

34 lines
1.3 KiB
Markdown

# Warpgate
Warpgate is a smart SSH bastion host for Linux that can be used with _any_ SSH client.
* Set it up in your DMZ, add user accounts and easily assign them to specific hosts within the network.
* Warpgate will record every session for you to replay and review later through a built-in admin web UI.
* Single-file statically linked binary with no dependencies.
* Written in 100% safe Rust.
## Getting started
See the [Getting started](https://github.com/Eugeny/warpgate/wiki/Getting-started) wiki page.
## Project Status
The project is currently in **alpha** stage and is gathering community feedback. See the [official roadmap](https://github.com/users/Eugeny/projects/1/views/2) for the upcoming features.
In particular, we're working on:
* Support for exposing HTTP(S) endpoints through the bastion,
* Support for tunneling database connections,
* Live session view and control,
* Requesting admin approval for sessions
* and much more.
## Contributing / building from source
* Clone the repo
* [Just](https://github.com/casey/just) is used to run tasks - install it: `cargo install just`
* Install the admin UI deps: `just yarn`
* Build the API SDK: `just openapi-client`
* Build the frontend: `just yarn build`
* Build Warpgate: `cargo build` (optionally `--release`)