diff --git a/README.md b/README.md index 071ac22..1ae9004 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,24 @@ -# Helios +

Helios - Identity-aware Proxy

Helios is an Identity & Access Proxy (IAP) that authorizes HTTP requests based on sets of rules. -It is the building block towards [BeyondCorp](https://beyondcorp.com), a model designed by Google to secure applications in Zero-Trust networks. -An Identity & Access Proxy is typically deployed in front of (think API Gateway) web-facing applications -and is capable of authenticating and optionally authorizing access requests. +It is the building block towards [BeyondCorp](https://beyondcorp.com), a model designed by Google to secure applications +in Zero-Trust networks. + +My goal is to build an open source alternative to +[Cloudflare Access](https://www.cloudflare.com/products/cloudflare-access/) +and [Cloud IAP](https://cloud.google.com/iap/). + +In a nutshell, with Helios you can: + +* Identify users using existing identity providers like Google, Auth0, Okta and more +* Secure and authenticate access to any domain or path +* Configure authorization policies using [CEL](https://github.com/google/cel-spec) expressions +* Use Helios as gateway or reverse proxy + +**Another Go proxy?** + +This is a project I started off for 2 reasons: I wanted to exercise and continue improving my Go skills, and because +I'm very interested in BeyondCorp model. This is a side project of mine but I'm determined to reach a stable version. ## Development @@ -26,7 +41,7 @@ Create a certificate for local development mkcert localhost 127.0.0.1 ``` -### Developing +### Usage Install dependencies diff --git a/docs/images/banner.png b/docs/images/banner.png new file mode 100644 index 0000000..fa2866a Binary files /dev/null and b/docs/images/banner.png differ