Merge pull request #549 from tristan-chauveau/master

updating manual

manual/src/main/paradox/getotoroshi/fromsources.md

@@ -32,7 +32,7 @@ Go to the `documentation` folder and run :
 sbt ';clean;paradox'
 ```
 
-The documentation is located at `documentation/target/paradox/site/main/`
+The documentation is located at `manual/target/paradox/site/main/`
 
 ## Build the React UI
 

manual/src/main/paradox/integrations/analytics.md

@@ -4,6 +4,10 @@ Each action and request on Otoroshi creates events that can be sent outside of O
 
 ## Push events to Elasticsearch
 
+@@@ warning
+Otoroshi supports only Elasticsearch versions under 7.0
+@@@
+
 You can use elastic search to store otoroshi events. To do this you have to configure the access to elasticsearch from `settings (cog icon) / Danger Zone` and expand the `Analytics: Elastic cluster (write)` section.
 
 @@@ div { .centered-img }

manual/src/main/paradox/setup/admin.md

@@ -18,6 +18,12 @@ You will see the list of registered admin users.
 <img src="../img/first-admins-screen.png" />
 @@@
 
+Click on `Register admin.`
+
+@@@ div { .centered-img }
+<img src="../img/register-admin-button.png" />
+@@@
+
 Now, enter informations about the new admin you want to create.
 
 @@@ div { .centered-img }
@@ -38,10 +44,10 @@ Now, you can discard the generated admin, confirm, then logout, login with the a
 
 ## Create admin user with U2F device login
 
-Go to `settings (cog icon) / Admins`.
+Go to `settings (cog icon) / Admins`, click on `Register Admin`.
 
 @@@ div { .centered-img }
-<img src="../img/first-admins-screen.png" />
+<img src="../img/register-admin-button.png" />
 @@@
 
 Enter informations about the new admin you want to create.
@@ -50,7 +56,7 @@ Enter informations about the new admin you want to create.
 <img src="../img/create-admin-u2f.png" />
 @@@
 
-Click on `Register FIDO U2F Admin`.
+Click on `Register Admin with WebAuthn`.
 
 Otoroshi will  ask you to plug your FIDO U2F device and touch it to complete registration.
 

manual/src/main/paradox/setup/dangerzone.md

@@ -17,7 +17,11 @@ This part allows you to configure various things :
 * `No Auth0 login` => allow you to disabled Auth0 login to the Otoroshi admin dashboard
 * `API read only` => disable `writes` on the Otoroshi admin api
 * `Use HTTP streaming` => use http streaming for each response. It should always be true
+* `Auto link default` => when no group is specified on a service, it will be assigned to default one
 * `Use circuit breakers` => allow usage of circuit breakers for each service
+* `Log analytics on servers` => all analytics will be logged on the servers
+* `Use new http client as the default Http client` => all http call will use the new http client client by default
+* `Enable live metrics` => enable live metrics in the Otoroshi cluster. Performs a lot of writes in the datastore
 * `Digitus medius` => change the character of endless HTTP responses from `0` to `🖕`
 * `Limit concurrent requests` => allow you to specify a max number of concurrent requests on an Otoroshi instance to avoid overloading
 * `Max concurrent requests` => max allowed number of concurrent requests on an Otoroshi instance to avoid overloading
@@ -77,6 +81,8 @@ For more information about Kafka integration and what it does, just go to the @r
 
 Each time a dangerous action or something unusual is performed on Otoroshi, it will create an alert and store it. You can be notified for each of these alerts using `WebHooks` or emails. To do so, just add the `WebHook` URL and optional headers in the `Danger Zone` or any email address you want (you can add more than one email address).
 
+You can enable mutual authentication via the `Use mTLS` button and add your certificates. The `TLS loose` option will block all untrustful ssl configs, the `TrustAll` option allows any server certificates even the self-signed ones.
+
 @@@ div { .centered-img }
 <img src="../img/danger-zone-6-alerts.png" />
 @@@

manual/src/main/paradox/setup/index.md

@@ -4,13 +4,7 @@ Now that Otoroshi is running, you are ready to log into the Otoroshi admin dashb
 
 <a href="http://otoroshi.oto.tools:8080" target="_blank">http://otoroshi.oto.tools:8080</a>
 
-and you will see the following page
-
-@@@ div { .centered-img }
-<img src="../img/base-page.png" />
-@@@
-
-now click on the login button and you will see the login page
+and you will see the login page
 
 @@@ div { .centered-img }
 <img src="../img/login-page.png" />

manual/src/main/paradox/usage/2-services.md

@@ -27,11 +27,12 @@ You will have a serie of toggle buttons to
 * display contruction page for a service
 * enable otoroshi custom response headers containing request id, latency, etc 
 * force https usage on the exposed service
+* enable read only flag : this service will only be used with `HEAD`, `OPTIONS` and `GET` http verbs. You can also active the same flag on `ApiKey`s to be more specific on who cannot use write http verbs.
 
 Then, you will be able to choose the URL that will be used to reach your new service on Otoroshi.
 
 @@@ div { .centered-img #service-flags }
-<img src="../img/service-flags-2.png" />
+<img src="../img/service-flags.png" />
 @@@
 
 In the `service targets` section, you will be able to choose where the call will be forwarded. You can use multiple targets, in that case, Otoroshi will perform a round robin load balancing between the targets. If the `override Host header` toggle is on, the host header will be changed for the host of the target. For example, if you request `http://www.oto.tools/api` with a target to `http://www-internal.service.local/api`, the target will receive a `Host: www-internal.service.local` instead of `Host: www.oto.tools`.
@@ -138,15 +139,18 @@ In Otoroshi, each service has its own client settings with a circuit breaker and
 
 You can also provide some additionnal information about a given service, like an `Open API` descriptor, some metadata, a list of whitelisted/blacklisted ip addresses, etc.
 
-Here you can also define some headers that will be added to each request to the targets. And you will be able to define headers to route the call only if the defined header is present on the request.
-
 @@@ div { .centered-img #service-meta }
 <img src="../img/new-service-meta.png" />
 @@@
 
-### Read only
+### HTTP Headers
+
+Here you can define some headers that will be added to each request to client requests or responses. 
+You will also be able to define headers to route the call only if the defined header is present on the request.
 
-The read only flag on a service descriptor means that this service can only be used with `HEAD`, `OPTIONS` and `GET` http verbs. You can also active the same flag on `ApiKey`s to be more specific on who cannot use write http verbs.
+@@@ div { .centered-img #service-meta }
+<img src="../img/new-service-headers.png" />
+@@@
 
 ### CORS 
 

manual/src/main/paradox/usage/4-monitor.md

@@ -6,7 +6,7 @@ Once you have declared services, you can monitor them with Otoroshi.
 You have to use [Elastic](https://www.elastic.co) to enable analytics features in Otoroshi
 @@@
 
-Once you have setup @ref:[Otoroshi events push to an elastic cluster](../integrations/analytics.md) (through webhooks, kafka, or elastic integration) you can setup Otoroshi events read from an elastic cluster. Go to `settings (cog icon) / Danger Zone` and expand the `Analytics: Elastic dashboard datasource (read)` section.
+Once you have setup @ref:[Otoroshi events push to an elastic cluster](../integrations/analytics.md) (through webhooks, kafka, or elastic integration) you can setup Otoroshi events read from an elastic cluster. Go to `settings (cog icon) / Danger Zone` and expand the `Analytics: Elastic cluster (write)` section.
 
 @@@ div { .centered-img }
 <img src="../img/push-to-elastic.png" />

manual/src/main/paradox/usage/6-audit.md

@@ -22,6 +22,12 @@ To see last `app.events.maxSize` alerts on Otoroshi from the UI, go to `settings
 <img src="../img/alerts-log.png" />
 @@@
 
+You can also have a look at the payload sent to the Otoroshi server by clicking the `content` button
+
+@@@ div { .centered-img }
+<img src="../img/alerts-log-content.png" />
+@@@
+
 ## List of possible alerts
 
 ```

manual/src/main/paradox/usage/9-auth.md

@@ -1,6 +1,6 @@
 # Authentication
 
-You can create auth. configuration in Otoroshi. Just go to `settings (cog icon) / Global auth. configs`.
+You can create auth. configuration in Otoroshi. Just go to `settings (cog icon) / Authentication configs`.
 
 ## OAuth 2