Skip to content

Commit

Permalink
doc cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
niloc132 committed Feb 16, 2023
1 parent ba98d83 commit db7def3
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion authentication/example-providers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ This directory contains several example authentication providers, which can be a
and configured to authenticate the user.

As these are only examples and not intended to replace actual integrations, they may have some limitations in how
they can be configured and deployed, but also are built as a single `.jar` file with no external dependencies or
they can be configured and deployed, but also are built as a single `.jar` file with no external dependencies or
conflicts to manage.

### [Pre-Shared Key](psk)
Expand Down
6 changes: 3 additions & 3 deletions authentication/example-providers/mtls/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ To use this from a pre-built installation:
* Add the mtls-authentication-provider jar to your Deephaven installation's classpath:
* If running the `bin/start` script, this can be accomplished by adding it to the `EXTRA_CLASSPATH` environment variable.
* If running from docker, add the jar to the `/apps/lib/` directory.
* Configure the server to use this by specifying that the `AuthHandlers` configuration should include
`io.deephaven.authentication.mtls.MTlsAuthenticationHandler`. AuthHandlers is a comma-separated string, more than one
* Configure the server to use this by specifying that the `AuthHandlers` configuration should include
`io.deephaven.authentication.mtls.MTlsAuthenticationHandler`. AuthHandlers is a comma-separated string, more than one
can be specified to enable multiple authentication handlers.

## Testing from the browser
First install a client certificate in the browser. This process depends on the browser in use. Connect to
First install a client certificate in the browser. This process depends on the browser in use. Connect to
https://<server-hostname>/jsapi/authentication/mtls.html and click "Go" for a simple test to confirm that the server
accepts the certificate.

Expand Down
6 changes: 3 additions & 3 deletions authentication/example-providers/oidc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,21 @@ This module, and its related client-side code, enables the use of Keycloak as an
optionally with roles defined in that service.

Keycloak is too big of a topic to discuss in this documentation, but this module offers a simple Keycloak deployment
and integration to use it from a simple html page.
and integration to use it from a simple html page.

For the sake of simplicity, the server and client both today assume that the OpenID Connect server is KeyCloak, but the
server component is designed using [Pac4j](https://www.pac4j.org/), making it flexible enough to support not only
general OpenID Connect services, but also other kinds of single-sign on services like SAML, OAuth, etc.

## Example Keycloak setup
In this directory, run `docker-compose up` to start Keycloak and database for it.When the container first starts up, a
In this directory, run `docker-compose up` to start Keycloak and database for it. When the container first starts up, a
[JSON file](deephaven_realm.json) configures a realm and a client that can access it, and two users: `admin`/`admin` and
`user`/`user`. This docker-compose configuration is designed to be fast to start and ephemeral, and is not meant for
production use.

After that has run, there will be a docker container running with port 6060 exposed on localhost. The account to
administer the keycloak instance is `admin`/`admin`. Note that this account is for the "master" realm, and isn't related
to the admin account above for the "deephaven_core" realm.
to the admin account above for the "deephaven_core" realm.

## Server setup
To test this when building from gradle with `:server-jetty-app:run`, specify `-Poidc` to enable this.
Expand Down
2 changes: 1 addition & 1 deletion authentication/example-providers/psk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ A pre-shared key is a simple way to easily configure a server and demonstrate th
to do so. Most people are familiar with this in the context of using a WiFi password, via WPA-PSK, where every user
enters the same password into all of their devices to connect to the wireless network.

Like WiFi, in the context of Deephaven, this is a simple alternative to permitting any user to anonymously connect and
Like WiFi, in the context of Deephaven, this is a simple alternative to permitting any user to anonymously connect and
consume any resources. If enabled with no parameters, the server will generate a new password on each startup and log
it for the user to see. Alternatively, a password can be configured, and this will always be used.

Expand Down

0 comments on commit db7def3

Please sign in to comment.