Skip to content

Commit

Permalink
fix(docs): minor updates to the README (#7366)
Browse files Browse the repository at this point in the history
Signed-off-by: ossdhaval <343411+ossdhaval@users.noreply.github.com>
Co-authored-by: nynymike <mike@gluu.org>
  • Loading branch information
ossdhaval and nynymike committed Jan 15, 2024
1 parent a4b8829 commit 4859057
Showing 1 changed file with 29 additions and 10 deletions.
39 changes: 29 additions & 10 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,39 +2,58 @@

## Introduction

Janssen enables organizations to build a scalable centralized authentication and authorization service using free open source software. The components of the project include client and server implementations of the OAuth, OpenID Connect, SCIM and FIDO standards.
Janssen is a distribution of open source identity components which
organizations can use to build a scalable federated authentication and
authorization service. This documentation is always work in progress. Please
help to make it better by submitting a PR if you can think of any way to
improve it!

## Administration Guide

The Janssen Server is highly extensible and customizable. Resources for deployment, operation, and maintenance of the Janssen environment are available in the [Administration guide](admin/README.md). We recommend a holistic approach to identity, planning the environment thoroughly using the [Deployment Guide](admin/planning/platform-goal.md). For a quick start for testing, you can jump right into [Installation](admin/install/vm-install/README.md).
Read the [Administration guide](admin/README.md) to learn how to deploy, operate
and maintain the Janssen components. Planning your solution using the
[Deployment Guide](admin/planning/platform-goal.md). An easy way to get started
is to try Janssen on an VM, see [Installation](admin/install/vm-install/README.md)
or check the other docs for Kubernetes based installation.

## Contribution Guide

There are many ways the community can contribute to the Janssen Project. Of course, you can contribute code. But we also need people to write documentation and guides, to help us with testing, to answer questions on the forums and chat, to review PRs, to help us with devops and CI/CD, to provide feedback on usability, and to promote the project through outreach. Also, by sharing metrics with us, we can gain valuable insights into how the software performs in the wild. Resources to get started are available [here](CONTRIBUTING.md).

## Governance Guide

The Janssen Project is an open source member of the Linux Foundation. Information about the project's governance can be found [here](governance/charter.md).
The Janssen Project is chartered under the Linux Foundation. Information about
the project's governance can be found [here](governance/charter.md).

## Script Catalog

Interception scripts (or custom scripts) allow you to define custom business logic for various features offered by the OpenID Provider (Jans-auth server). Some examples of features which can be customized are - implementing a 2FA authentication method, consent gathering, client registration, adding business specific claims to ID token or Access token etc. Scripts can easily be upgraded and doesn't require forking the Jans Server code or re-building it.

The definitive location for scripts and their documentation is the [Script Catalog](script-catalog/README.md).
Interception scripts (or custom scripts) allow you to define custom business
logic for various features in Janssen without forking the Jans Server core
project. Interceptions scripts are available for many components, including
Auth Server, SCIM, FIDO, and Link. The definitive location for scripts and their
documentation is the [Script Catalog](admin/developer/scripts/README.md).

## Agama

[Agama](admin/developer/agama/quick-start-using-agama-lab.md) is a component of the Janssen authentication server that offers an alternative way to build web-based authentication flows. Typically, person authentication flows are defined in the server by means of jython scripts that adhere to a predefined API. With Agama, flows are coded using a DSL (domain specific language) designed for the sole purpose of writing web flows.
[Agama](agama/introduction/README.md) is a domain specific language ("DSL")
designed for writing web flows, and a project archive format (".gama") which
stores all the code and web assets required for deployment of an Agama project
by an identity provider. Although invented by Janssen, we envision many IDP's
using Agama as a cross-vendor standard for identity orchestration.

## Support

We prefer to have all our discussions through [GitHub Discussions](https://github.com/JanssenProject/jans/discussions) to better facilitate faster responses. However, other means are available such as the [community chat on Gitter](https://gitter.im/JanssenProject/Lobby). You can register for free there with your Github identity.
If you have any questions about usage, post on [Jans Discussions](https://github.com/JanssenProject/jans/discussions) or try [community chat on Gitter](https://gitter.im/JanssenProject/Lobby).

If you find a bug in a Janssen project, or you would like to suggest a new feature, try the [GitHub Discussions](https://github.com/JanssenProject/jans/discussions) first. If you have a "howto" or "usage" question, [raise the question or usage](https://github.com/JanssenProject/jans/discussions)!
If you find a bug in a Janssen project, or you would like to suggest a new
feature, you should also post on [GitHub Discussions](https://github.com/JanssenProject/jans/discussions) first. The Jans team will try to replicate the bug, or weigh the feature request versus current priorities.

## License

The Janssen Project is licensed under the [Apache License 2.0](https://github.com/JanssenProject/jans/blob/main/LICENSE). The Janssen Server is highly extensible and can be used with a variety of other products and projects, which may fall under other licenses.
Most Janssen Project components are licensed under the [Apache License 2.0](https://github.com/JanssenProject/jans/blob/main/LICENSE). Janssen has some third party components,
so it's always best to check the license for each component. We won't include
any component in the distribution that has a non-[OSI](https://opensource.org/)
approved license, or a commercial trademark.

## Looking for older documentation versions?

Expand Down

0 comments on commit 4859057

Please sign in to comment.