Skip to content
This repository was archived by the owner on May 2, 2023. It is now read-only.

Commit bd42130

Browse files
committed
Add roadmap
1 parent 255f0f3 commit bd42130

File tree

1 file changed

+19
-11
lines changed

1 file changed

+19
-11
lines changed

README.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ in Zero-Trust networks.
1212

1313
In a nutshell, with Helios you can:
1414

15-
* Identify users using existing identity providers like Google, Auth0, Okta, etc.
15+
* Identify users using existing identity providers like Google, Auth0, Azure AD, etc.
1616
* Secure and authenticate access to any domain or path
1717
* Configure authorization policies using [CEL](https://github.com/google/cel-spec) expressions
1818
* Use Helios as gateway or reverse proxy
@@ -25,17 +25,14 @@ and [Cloud IAP](https://cloud.google.com/iap/).
2525

2626
Beyond that, I started this project off for 2 reasons:
2727

28-
1. I wanted to exercise and continue improving my Go skills
28+
1. I wanted to exercise and continue improving my Go skills.
2929
2. I'm interested in BeyondCorp, Google's implementation of [Zero Trust](https://wikipedia.org/wiki/Zero_Trust). I
3030
believe Zero Trust is the future of Enterprise Security.
31+
3. Last but not least, because it's fun!
3132

3233
## Install
33-
First, install Go, set your `GOPATH`, and make sure `$GOPATH/bin` is on your PATH.
3434

35-
```shell
36-
$ export GOPATH="$HOME/go"
37-
$ export PATH="$PATH:$GOPATH/bin"
38-
```
35+
[Install Go](https://golang.org/doc/install).
3936

4037
Next download the project and build the binary file.
4138

@@ -58,10 +55,10 @@ helios -help
5855
### Configuring authorization rules
5956

6057
The supported condition attributes are based on details about the request (e.g., its timestamp, originating IP address
61-
, etc).
62-
Examples and a description attribute types are described below.
58+
, identity, etc.).
59+
Examples and a description of attribute types are described below.
6360

64-
### Request Attributes
61+
#### Available Attributes
6562

6663
- `request.host`
6764
- `request.path`
@@ -118,7 +115,7 @@ request.path.startsWith("/admin")
118115

119116
### Prerequisites
120117

121-
- Go 1.12
118+
- Go 1.13
122119
- [mkcert](https://github.com/FiloSottile/mkcert)
123120

124121
### Environment Setup
@@ -146,3 +143,14 @@ Run the program
146143
```shell
147144
go run . -config config.example.yaml
148145
```
146+
147+
## Roadmap 🗺
148+
149+
| Status | Milestone |
150+
| :---: | :--- |
151+
| 🚀 | Expression engine |
152+
|| Support popular identity providers |
153+
|| Use templates for error pages |
154+
|| Export prometheus metrics |
155+
|| Create a Github page |
156+
|| Dynamic policies |

0 commit comments

Comments
 (0)