Skip to content

Commit

Permalink
doc(oidc,settings): align terminology to JVM options and explain some…
Browse files Browse the repository at this point in the history
… more about MPCONFIG
  • Loading branch information
poikilotherm committed Oct 3, 2023
1 parent 274f0e9 commit a2b9d56
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 8 deletions.
5 changes: 5 additions & 0 deletions doc/sphinx-guides/source/installation/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1699,6 +1699,11 @@ When changing values these values with ``asadmin``, you'll need to delete the ol

It's also possible to change these values by stopping Payara, editing ``payara6/glassfish/domains/domain1/config/domain.xml``, and restarting Payara.

In addition, JVM options enabled for "MicroProfile Config" (see docs of any option), can be used with any
`supported MicroProfile Config API source`_ to provide their values. The most notable source are environment variables;
many examples are given in detail documentation of enabled options.


.. _dataverse.fqdn:

dataverse.fqdn
Expand Down
20 changes: 12 additions & 8 deletions doc/sphinx-guides/source/installation/oidc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,14 +94,14 @@ Provision a Provider

Depending on your use case, you can choose different ways to setup one or multiple OIDC identity providers.

Using MicroProfile Config has the advantage of being consistent and does not require additional calls to the API.
Using :ref:`jvm-options` has the advantage of being consistent and does not require additional calls to the API.
It can only configure one provider though, yet you can mix with other provider definitions via API.

Using the REST API has the advantage of provisioning multiple, different OIDC providers.
Depending on your use case, it has the drawback of needing additional API calls.

If you only need one single provider in your installation and it is using OIDC, use the MPCONFIG option, as it requires
fewer extra steps and allows you to keep more configuration in a single source.
If you only need one single provider in your installation and it is using OIDC, use the JVM options, as it
requires fewer extra steps and allows you to keep more configuration in a single source.

Provision via REST API
^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -125,12 +125,16 @@ section of the User Guide.

.. _oidc-mpconfig:

Provision via MPCONFIG
^^^^^^^^^^^^^^^^^^^^^^
Provision via JVM Options
^^^^^^^^^^^^^^^^^^^^^^^^^

A single provider may be provisioned using :ref:`jvm-options`.
It may be accompanied by more providers configured via REST API.
Note that this provider will only be deployed at startup time and (currently) cannot be reconfigured without a restart.

In case you only require a single OIDC provider, you can also provision an OIDC based provider using MicroProfile Config
sources. Note that this provider will only be deployed at startup time and (currently) cannot be reconfigured without
a restart.
All options below may be set via *MicroProfile Config API* sources. Examples: use environment variable
``DATAVERSE_AUTH_OIDC_ENABLED`` for the ``dataverse.auth.oidc.enabled`` option or ``DATAVERSE_AUTH_OIDC_CLIENT_ID``
for the ``dataverse.auth.oidc.client-id`` option.

The following options are available:

Expand Down

0 comments on commit a2b9d56

Please sign in to comment.