ory · aeneasr · Feb 17, 2018 · Feb 17, 2018
@@ -1,12 +1,23 @@
 {
-    "root": "./docs",
-    "author": "Aeneas Rekkas",
-    "gitbook": ">=3.2.0",
-    "plugins": ["edit-link"],
-    "pluginsConfig": {
-        "edit-link": {
-            "base": "https://github.com/ory/hydra/tree/master/docs",
-            "label": "Edit this page on GitHub"
-        }
+  "root": "./docs",
+  "author": "Aeneas Rekkas",
+  "gitbook": ">=3.2.0",
+  "plugins": [
+    "edit-link",
+    "summary",
+    "etoc"
+  ],
+  "pluginsConfig": {
+    "edit-link": {
+      "base": "https://github.com/ory/hydra/tree/master/docs",
+      "label": "Edit this page on GitHub"
+    },
+    "etoc": {
+      "h2lb": 2,
+      "mindepth": 2,
+      "maxdepth": 5,
+      "notoc": false
     }
-}
+  }
+}
+
@@ -3,9 +3,9 @@
 To start off easy, ORY Hydra provides a docker-compose based example for setting up ORY Hydra, a PostgreSQL instance
 and an exemplary consent app (identity provider). You need to have the latest Docker version installed.
 
-<img src="images/oauth2-flow.gif" alt="OAuth2 Flow">
+<img src="../images/oauth2-flow.gif" alt="OAuth2 Flow">
 
-<img alt="Running the example" align="right" width="35%" src="images/run-the-example.gif">
+<img alt="Running the example" align="right" width="35%" src="../images/run-the-example.gif">
 
 Install [Docker and Docker Compose](https://github.com/ory-am/hydra#installation) and either clone the Hydra git repository,
 download [this zip file](https://github.com/ory-am/hydra/archive/master.zip) or use `go get github.com/ory/hydra` if you have Go (1.8+) installed on you system.

@@ -0,0 +1 @@
+# Understanding ORY Hydra
@@ -41,7 +41,7 @@ uses the Identity Provider to authenticate peter, for example by using cookies o
 If you are new to OpenID Connect, please read the [Introduction to OAuth 2.0 and OpenID Connect](README.md#introduction-to-oauth-20-and-openid-connect)
 first. 
 
-Hydra uses the [JSON Web Key Manager](./jwk.md) to retrieve the
+Hydra uses the [JSON Web Key Manager](2-JWK.md) to retrieve the
 key pair `hydra.openid.id-token` for signing ID tokens. You can use that endpoint to retrieve the public key for verification.
 Additionally, Hydra supports OpenID Connect Discovery.
 
@@ -67,7 +67,7 @@ login service ("user management") and implement the consent flow with it.
 
 Let us look at the sequence of requests being made to successfully perform an OAuth 2.0 authorize code flow using ORY Hydra:
 
-![Consent flow sequence diagram](./images/consent-flow.svg)
+![Consent flow sequence diagram](../images/consent-flow.svg)
 
 The state machine of the consent app itself typically looks as followed.
 
@@ -87,7 +87,7 @@ CHA-->CHR
 CHR-->|Redirect to redirectUrl value|H2{Hydra}
 -->
 
-![Consent app state diagram](./images/consent-state.svg)
+![Consent app state diagram](../images/consent-state.svg)
 
 **Legend:**
 
@@ -109,9 +109,9 @@ consent request.
 
 Here is how Google chose to design the login and consent UI (what we call the "consent app"):
 
-![Google OAuth 2.0 Log In Screen](./images/google.png)
+![Google OAuth 2.0 Log In Screen](../images/google.png)
 
-![Google OAuth 2.0 Authorization In Screen](./images/google2.png)
+![Google OAuth 2.0 Authorization In Screen](../images/google2.png)
 
 ### Consent REST API
 

@@ -445,4 +445,4 @@ If your browser does not open automatically, navigate to:
 open the link, as prompted, in your browser, and follow the steps shown there. When completed, you should land
 at a screen that looks like this one:
 
-![OAuth 2.0 result](images/install-result.png)
+![OAuth 2.0 result](../images/install-result.png)
@@ -0,0 +1 @@
+# How To
@@ -3,4 +3,4 @@
 * [Golang](./sdk/go.md)
 * [JavaScript](./sdk/js.md)
 
-Missing your programming language? [Create an issue](https://github.com/ory/hydra/issues) and help us build, test and publish the SDK for your programming language!
+Missing your programming language? [Create an issue](https://github.com/ory/hydra/issues) and help us build, test and publish the SDK for your programming language!
@@ -1,5 +1,5 @@
 <h1 align="center" style="margin-bottom: 8px">
-    <img alt="Hydra - cloud native access control" src="images/logo-essential.png">
+    <img alt="Hydra - cloud native access control" src="../images/logo-essential.png">
 </h1>
 
 <h4 style="margin: 0 20% 1.275em" align="center">

@@ -1,82 +1,16 @@
-# Summary
-
-* [Introduction](README.md)
-  * [Introduction to OAuth 2.0 and OpenID Connect](README.md#introduction-to-oauth-20-and-openid-connect)
-  * [Introduction to Hydra](README.md#introduction-to-hydra)
-  * [OAuth2 Case Study](README.md#oauth-20-case-study)
-* [Introduction Tutorial (5 minutes)](tutorial.md)
-* [Dependencies](environment.md)
-* Understanding Hydra
-  * [OAuth2 & OpenID Connect](oauth2.md)
-    * [Overview](oauth2.md#overview)
-    * [Confirming User Consent: Consent Flow](oauth2.md#consent-flow)
-    * [Validating Tokens: OAuth2 Token Introspection](oauth2.md#oauth2-token-introspection)
-    * [OAuth2 Scopes](oauth2.md#oauth2-scopes)
-  * [JSON Web Keys](jwk.md)
-  * [Access Control](access-control.md)
-    - [Introduction](access-control.md#introduction)
-    - [Warden API](access-control.md#warden-api)
-    - [Groups](access-control.md#groups)
-    - [Best Practices](access-control.md#best-practices)
-      - [Scalability](access-control.md#scalability)
-      - [URNs](access-control.md#urns)
-      - [Scope the Organization Name](access-control.md#scope-the-organization-name)
-      - [Scope Actions, Resources and Subjects](access-control.md#scope-actions-resources-and-subjects)
-      - [Multi-Tenant Systems](access-control.md#multi-tenant-systems)
-    - [Conditions & Context](access-control.md#conditions-&-context)
-      - [CIDR Condition](access-control.md#cidr-condition)
-      - [String Equal Condition](access-control.md#string-equal-condition)
-      - [String Match Condition](access-control.md#string-match-condition)
-      - [Subject Condition](access-control.md#subject-condition)
-      - [String Pairs Equal Condition](access-control.md#string-pairs-equal-condition)
-- [Install, Configure and Run ORY Hydra (15 minutes)](install.md#install-configure-and-run-ory-hydra)
-  - [Create a Network](install.md#create-a-network)
-  - [Start a PostgreSQL container](install.md#start-a-postgresql-container)
-  - [Install and run ORY Hydra](install.md#install-and-run-ory-hydra)
-    - [Install ORY Hydra without Docker](install.md#install-ory-hydra-without-docker)
-      - [Download binaries](install.md#download-binaries)
-      - [Build from source](install.md#build-from-source)
-  - [Configure ORY Hydra](install.md#configure-ory-hydra)
-    - [Setting up the consent app](install.md#setting-up-the-consent-app)
-  - [Perform OAuth 2.0 Flow](install.md#perform-oauth-20-flow)
-- [Security Overview](security.md#security-overview)
-  - [OAuth 2.0 Security Overview](security.md#oauth-20-security-overview)
-    - [Advanced Token Validation (Datastore Security)](security.md#advanced-token-validation-datastore-security)
-    - [Access Control Policies](security.md#access-control-policies)
-  - [Cryptography](security.md#cryptography)
-    - [AES-GCM](security.md#aes-gcm)
-    - [RS256](security.md#rs256)
-    - [HMAC-SHA256](security.md#hmac-sha256)
-    - [BCrypt](security.md#bcrypt)
-  - [Access Control](security.md#how-does-access-control-work-with-hydra)
-* [Telemetry](telemetry.md)
-* How-To
-  * [Running Hydra in production](how-to/production.md)
-* [SDKs](sdk.md)
-  * [SDK for Go](sdk/go.md)
-  * [SDK for JavaScript](sdk/js.md)
-  * [Other languages](sdk.md)
-* [Contribute](contribute.md)
-* [FAQ](faq.md)
-  - [How can I control SQL connection limits?](faq.md#how-can-i-control-sql-connection-limits)
-  - [Why is the Resource Owner Password Credentials grant not supported?](faq.md#why-is-the-resource-owner-password-credentials-grant-not-supported)
-  - [Should I use OAuth2 tokens for authentication?](faq.md#should-i-use-oauth2-tokens-for-authentication)
-  - [How to deal with mobile apps?](faq.md#how-to-deal-with-mobile-apps)
-  - [How should I run migrations?](faq.md#how-should-i-run-migrations)
-  - [What does the installation process look like?](faq.md#what-does-the-installation-process-look-like)
-  - [What does a migration process look like?](faq.md#what-does-a-migration-process-look-like)
-  - [How can I do this in docker?](faq.md#how-can-i-do-this-in-docker)
-  - [Can I set the log level to warn, error, debug, ...?](faq.md#can-i-set-the-log-level-to-warn-error-debug-)
-  - [How can I import TLS certificates?](faq.md#how-can-i-import-tls-certificates)
-  - [Is there an HTTP API Documentation?](faq.md#is-there-an-http-api-documentation)
-  - [How can I disable HTTPS for testing?](faq.md#how-can-i-disable-https-for-testing)
-  - [MySQL gives `unsupported Scan, storing driver.Value type []uint8 into type *time.Time`](faq.md#mysql-gives-unsupported-scan-storing-drivervalue-type-uint8-into-type-timetime)
-  - [Insufficient Entropy](faq.md#insufficient-entropy)
-  - [The docker image exits immediately](faq.md#the-docker-image-exits-immediately)
-  - [I get compile errors!](faq.md#i-get-compile-errors)
-  - [Is JWT supported?](faq.md#is-jwt-supported)
-  - [Refreshing tokens](faq.md#refreshing-tokens)
-  - [Revoking tokens & log out](faq.md#revoking-tokens-&-log-out)
-  - [Operational Considerations](faq.md#operational-considerations)
-    - [Managing Client/Policy Definitions](faq.md#managing-clientpolicy-definitions)
-  - [Recovering root client access](faq.md#recovering-root-client-access)
+- [5 Minute Tutorial](0-Tutorial/0-README.md)
+- [Dependencies & Environment](1-Environment/0-README.md)
+- [Understanding ORY Hydra](2-Overview/0-README.md)
+    - [OAuth 2.0 & OpenID Connect](2-Overview/1-OAUTH2.md)
+    - [JSON Web Keys](2-Overview/2-JWK.md)
+    - [Access Control](2-Overview/3-ACCESS-CONTROL.md)
+- [Install, Configure and Run ORY Hydra](3-Install/0-README.md)
+- [Security Overview](4-Security/0-README.md)
+- [Telemetry](5-Telemetry/0-README.md)
+- [How To](6-How To/0-README.md)
+    - [ORY Hydra in production](6-How To/1-PRODUCTION.md)
+- [SDK](7-SDK/0-README.md)
+    - [Go SDK](7-SDK/1-GO.md)
+    - [JavaScript SDK](7-SDK/2-JS.md)
+    - [PHP SDK](7-SDK/3-PHP.md)
+- [FAQ](8-FAQ/0-README.md)