During the main Mkdocs upgrade process, the Swagger implementation in oxd 4.0 broke the upgraded configuration.

I need to work out how to properly integrate Swagger with the new version of Mkdocs.

The original issue is here

We are doing following changes in oxd for Windows service installer:

1. Upgrading the version of Commons Daemon binary distributions for Windows in pom.xml.

2. Updating the location of the LICENSE file.

3. Updating the docs.

Let's remove the .beta from the docs branch and from the mkdocs url. We will keep it un-released though for now, i.e. the auto redirect from gluu.org/docs/oxd will continue to point to oxd 3.1.4 docs (not 4.0).

oxd-web : create configuration page for oxd-web

Add document page for 'Redis configuration' in oxd

Provide installation documentation for oxd-web
https://github.com/GluuFederation/docs-oxd-prod/blob/3.1.0/3.1.0/sources/install/index.md

New command described here:
GluuFederation/oxd#64

As template please use existing command https://gluu.org/docs/oxd/protocol/#get-tokens-id-access-by-code

sakitA commented 7 days ago • edited sakitA edited this issue 7 days ago

On the documentation (Library->Java) logout example code is not correct. On the code shows that user can set dummy token for id_token_hint but it is not correct. id_token_hint must be obtained from OP server. Otherwise OP return invalid_grant_type error

We need documentation which describes how exactly protect application with native library.

AFAIK we already have Demo for each library, so it's exactly what we need. Now in addition to Demo we have to describe in documentation how easy it is with link to actual Demo sources.

In protocol and in code we use oxd_id, not oxd-id. Current 3.0.1 version has hyphen instead of underscore sign.

Upgrade oxd 4.2.0 docs

Add tutorial on mtls demo using oxd.

Below are the broken links in oxd 3.1.2 document

Home

free open source- Gluu Server- https://www.gluu.org/docs/deployment
Ruby on Rails- https://www.gluu.org/docs/oxd/3.1.2/libraries/framework/rails/index.md

Libraries > Overview
Rails- https://www.gluu.org/docs/oxd/3.1.2/libraries/framework/rails/
Go- https://www.gluu.org/docs/oxd/3.1.2/libraries/api-client-libraries/languages/go/index.md
Java Play- https://www.gluu.org/docs/oxd/3.1.2/libraries/framework/play/

Java Spring
oxd-java library docs - https://gluu.org/docs/oxd/3.1.2/libraries/framework/languages/java/

--

In https://gluu.org/docs/oxd/3.1.1/libraries/framework/spring/ under installation guides, it's pointing to Github oxd-node not oxd spring repo.

Maybe we can add a reference to the readme of the repo, it looks like a very comprehensive guide...

It would be nice to have an enhanced code sample displays using some JS library like

• https://highlightjs.org
• http://prismjs.com
• https://github.com/google/code-prettify

Some pages of branch 4.0 found missing in 4.1 branches. For Example:

Branch 4.0
https://github.com/GluuFederation/docs-oxd-prod/tree/4.0/docs/sources/configuration
Branch 4.1
https://github.com/GluuFederation/docs-oxd-prod/tree/4.1/docs/sources/configuration

We need to check if 4.0, 4.1, 4.2 branch of oxd docs have correct contents as per enhancements and bug fix in each version. Ex: if we got new configuration pages in 4.0 and it’s missed in 4.1 then it's bug. We need to correct this.

oxd documentation for 3.1.0 version must include changes as described here:

• GluuFederation/oxd#49
• new setup_client command as described here GluuFederation/oxd#75
• describe new configuration property "protect_commands_with_access_token": false

Change c# library document as per python template and C# standard

Existing documentation for this endpoint is very short and doesn't document the semantic.

What is important for me as a developer:

• is id_token JWT signature validated
• which id_token's payload claims are validated and how

May I rely on that if this endpoint return 200 OK all validations in accordance with OpenID Connect standards are met?

Missing points in Python doc:

• The client application must have a valid SSL certificate, so the URL includes: https://

• The client hostname should be a valid hostname(FQDN), not a localhost or an IP Address. You can configure the hostname by adding the following entry in <> file:

• OS is not specified.

• Configure the Client Application section is removed.

• Looks like demo application won't run directly. No instruction about configuring SSL in demo application.

• Followed the instruction from https://github.com/GluuFederation/oxd-python/tree/master/examples/flask_app, and got below error:
  https://s3.amazonaws.com/uploads.hipchat.com/714532/5024370/lQhNX54OtncRSd2/upload.png

• Method names are not in sequence in the API document. (https://rawgit.com/GluuFederation/oxd-python/master/docs/html/client.html)

• All method descriptions are removed.

• Wrong method names:
  Setup Client is mentioned as Setup site
  Register Site is mentioned as Website Registration
  Get User Info is mentioned as Get User Claims

• Support section is removed.

• Do we need to document the private methods of the library which is not required by the client applications?

https://gluu.org/docs/oxd/3.1.4/upgrade/

Little modifications required ( for now ) in python-flask doc: https://gluu.org/docs/oxd/3.1.2/libraries/framework/flask/

• We need to install openjdk / oracle-java8 for oxd-server which is not available in Ubuntu 14.04. ( https://gluu.org/docs/oxd/3.1.2/libraries/framework/flask/#software-requirements )
• ox-conf.json and other configuration files installed inside /etc/oxd/oxd-server/; not in /opt/oxd-server/ ( https://gluu.org/docs/oxd/3.1.2/libraries/framework/flask/#configuring-oxd-server)

Docs Update for 4.2.2 branch

4.1 oxd docs should have instructions of installation from CE 4.1 package

Correcting update-site description and other text on api page.

Add doc section with details explanation of trust_all and SSL configuration.

Caused by: javax.net.ssl.SSLHandshakeException: sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target
at sun.security.ssl.Alerts.getSSLException(Alerts.java:192) ~[?:1.8.0_222]

CSharp

• Broken Links
  • Source from Github - Download the zip of the oxd CSharp library
    • https://codeload.github.com/GluuFederation/oxd-csharp/zip/3.1.2
  • oxd-csharp API docs for the auto-generated csharp docs
    • https://rawgit.com/GluuFederation/oxd-csharp/3.1.2/docs/html/index.html
  • See the code of a sample .Net app built using oxd-csharp
    • https://github.com/GluuFederation/oxd-csharp/tree/3.1.2/GluuDemoWebsite
  • The oxd_config.json file
    • https://github.com/GluuFederation/oxd-csharp/blob/3.1.2/GluuDemoWebsite/oxd_config.json

Go

• Broken Links
  • https://client.example.com/.well-known/openid-configuration
  • https://client.example.com/oxauth/.well-known/openid-configuration
• Wrong Links
  • uma_rpt_policies you can reference this document (points to 3.1.1)
    • https://gluu.org/docs/oxd/3.1.1/api/#uma-2-client-apis
  • Sample Project (points to 3.1.1)
    • https://github.com/GluuFederation/oxd-go/archive/3.1.1.zip

Java

• Wrong Links
  • Get User Info (Listed as Site Registration instead of Register Site)
  • uma_rpt_policies you can reference this document (points to 3.1.1)
    • https://gluu.org/docs/oxd/3.1.1/api/#uma-2-client-apis

Node

• Broken Links
  • Source from Github - Download
    • https://github.com/GluuFederation/oxd-node/archive/3.1.2.zip
  • Sample node app
    • https://github.com/GluuFederation/oxd-node/tree/3.1.2/oxd-node-demo

Perl

• Wrong Links
  • oxd-perl API docs for the auto-generated perl docs (API link is already taken, rename something else)
    • https://rawgit.com/GluuFederation/oxd-perl/3.1.2/docs/html/index.html

PHP

• Wrong Links
  • oxd-php API docs for the auto-generated perl docs (API link is already taken, rename something else; Link doesn't exist)
    • https://rawgit.com/GluuFederation/oxd-php-library/3.1.2/docs/html/index.html

Python

• Broken Links
  • Source from Github - Download
    • https://codeload.github.com/GluuFederation/oxd-python/zip/3.1.2
  • Sample Flask App
    • https://github.com/GluuFederation/oxd-python/blob/3.1.2/examples/flask_app
  • sample.cfg file
    • https://github.com/GluuFederation/oxd-python/blob/3.1.2/sample.cfg
• Wrong Links
  • oxd-python API docs for the auto-generated perl docs (API link is already taken, rename something else)
    • https://rawgit.com/GluuFederation/oxd-python/3.1.2/docs/html/index.html

Ruby

• Wrong Links
  • oxd-ruby API docs for the auto-generated perl docs (API link is already taken, rename something else)
    • http://www.rubydoc.info/gems/oxd-ruby/1.0.2

https://support.gluu.org/installation/6660/oxd-setup-client-access-token-cannot-be-introspected-due-to-no_setup_client_for_oxd_id/#at45127

Sync 4.2 docs with 4.1 changes and update version to 4.2

Though this document is for installing oxd server 3.1.1, Following this document installs oxd server 3.0.1
instead of oxd server 3.1.1. Can we change the document or make some fix in command so, following the commands will install oxd server 3.1.1