summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 25 insertions, 1 deletions
diff --git a/README.md b/README.md
index e29e796..cf7af05 100644
--- a/README.md
+++ b/README.md
@@ -46,6 +46,30 @@ I have ommitted TLS, RS256 from the prototype to offload the decision of key
management and rotation. See [smallstep](https://smallstep.com/docs/step-cli/)
for PKI management.
+CSV files are used instead of a database to simulate different types of
+scenarios. The following organizational hierarchy is demonstrated here:
+
+```
+Organization(name: "default")
+ * Group(name: "A")
+ * Project(name: "A1"
+ * Group(name: "B")
+ * Project(name: "B1"
+Organization(name: "gitlab")
+ * Group(name: "gitlab-org")
+ * Project(name: "gitlab")
+ * Group(name: "gitlab-com")
+ * Group(name: "gl-security")
+ * Group(name: "test-projects")
+ * Project(name: "eicar-test-project")
+ * Project(name: "disclosures")
+ * Group(name: "support")
+ * Group(name: "toolbox")
+ * Project(name: "changelog-parser")
+ * Project(name: "handbook")
+ * Project(name: "www-gitlab-com")
+```
+
## Getting Started
1. Install tools:
@@ -69,7 +93,7 @@ for PKI management.
$ mage
```
-1. Open browser to `http://ui.example.com:8080/saml/new` to start a new SAML
+1. Open a browser to `http://ui.example.com:8080/saml/new` to start a new SAML
session. Or open `http://ui.example.com:8080/oidc/new` to start a new OIDC
session.