gluufederation / docs-oxd-prod Goto Github PK
View Code? Open in Web Editor NEWProduction documentation repo for the oxd OAuth2 client software for server-side web apps.
Home Page: https://gluu.org/docs/oxd
License: Other
Production documentation repo for the oxd OAuth2 client software for server-side web apps.
Home Page: https://gluu.org/docs/oxd
License: Other
oxd documentation for 3.1.0 version must include changes as described here:
"protect_commands_with_access_token": false
CSharp
Go
Java
Node
Perl
PHP
Python
Ruby
oxd-web : create configuration page for oxd-web
Provide installation documentation for oxd-web
https://github.com/GluuFederation/docs-oxd-prod/blob/3.1.0/3.1.0/sources/install/index.md
Add tutorial on mtls demo using oxd.
Correcting update-site
description and other text on api page.
Little modifications required ( for now ) in python-flask doc: https://gluu.org/docs/oxd/3.1.2/libraries/framework/flask/
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)In protocol and in code we use oxd_id
, not oxd-id
. Current 3.0.1 version has hyphen instead of underscore sign.
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).
Existing documentation for this endpoint is very short and doesn't document the semantic.
What is important for me as a developer:
May I rely on that if this endpoint return 200 OK all validations in accordance with OpenID Connect standards are met?
Upgrade oxd 4.2.0 docs
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]
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.
It would be nice to have an enhanced code sample displays using some JS library like
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?
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/
--
4.1 oxd docs should have instructions of installation from CE 4.1 package
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.
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
Sync 4.2 docs with 4.1 changes and update version to 4.2
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
Docs Update for 4.2.2 branch
Change c# library document as per python template and C# standard
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...
We are doing following changes in oxd for Windows service installer:
Upgrading the version of Commons Daemon binary distributions for Windows
in pom.xml.
Updating the location of the LICENSE file.
Updating the docs.
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
Add document page for 'Redis configuration' in oxd
A declarative, efficient, and flexible JavaScript library for building user interfaces.
π Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. πππ
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google β€οΈ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.