From 016bf37e1997e5e07f7364b4254e7b626c4b3f53 Mon Sep 17 00:00:00 2001 From: Michael Schwartz Date: Tue, 17 Sep 2024 21:35:43 -0500 Subject: [PATCH] docs: update README.md for Lock changes (#9509) Updated README - Jans Lock and intro edit. Co-authored-by: Dhaval D <343411+ossdhaval@users.noreply.github.com> --- README.md | 61 +++++++++++++++++++++---------------------------------- 1 file changed, 23 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index b7ac676b352..26cfbfdea97 100644 --- a/README.md +++ b/README.md @@ -5,36 +5,21 @@ [![The Linux Foundation](https://img.shields.io/badge/Member-The%20Linux%20Foundation-blue?style=flat-square)](https://www.linuxfoundation.org/press/press-release/the-janssen-project-takes-on-worlds-most-demanding-digital-trust-challenges-at-linux-foundation) [![DPGA](https://img.shields.io/badge/DPGA-Digital%20Public%20Good-green?style=flat-square)](https://app.digitalpublicgoods.net/a/10470) -An open source digital identity platforms that scales, Janssen is a software -distribution of standards-based, developer-friendly components that are -engineered to work together in any cloud. -* Develop your identity solution using low code on - [Agama Lab](https://agama-lab.gluu.org) -* Use Helm, Rancher, or OpenTofu to deploy your solution in a Kubernetes - cluster. -* Connect your solution to mobile, web, and API software clients. - -Digital identity has a huge technical surface area. As you can see from -the commits on this projects, we write a lot of code. But we don't have to -write everything! Where it's synergistic, the project leverages third party -security components, like [Keycloak](https://www.keycloak.org/) and [Open Policy Agent](https://www.openpolicyagent.org/). We favor security -software that lives under the Linux Foundation umbrella, but other community -governed open source components are ok too. - -The Janssen Project is the home of -[Agama](https://docs.jans.io/head/agama/introduction/), a programming language -for web login flows. Agama also defines the `.gama` file extension, an archive -format to standardize deployment of Agama code on any IDP. - -Janssen is a self-funded project chartered directly under the -Linux Foundation. It is recognized as a -[Digital Public Good](https://app.digitalpublicgoods.net/a/10470) by the -[DPGA](https://digitalpublicgoods.net/). Currently, a lot of contributions and -many core -contributors of the Janssen -Project are from the [Gluu team](https://gluu.org), who provide a -commercial -distribution called [Gluu Flex](https://gluu.org/flex). +Janssen is a self-funded project chartered directly under the Linux Foundation +to foster the development of enterprise digital identity and access management +infrastructure. As the lead Contributors, the [Gluu team](https://gluu.org) drives the +priorities on a day-to-day basis, governed and guided by the Janssen community +Technical Steering Commitee. + +There are several Janssen Components in different stages of development, from demos +to stable releases. Janssen Project software has batteries included. You +will find binaries, cloud native deployment assets, documentation and more-- +enabling you to build a product or mission critical cybersecurity service with +Janssen software. + +If your enteprise needs Janssen for a production deployment, Gluu offers a +commercial distribution of Janssen Project Components called +[Gluu Flex](https://gluu.org/flex) and [hosting](https://gluu.org/solo). ---- @@ -70,22 +55,22 @@ distribution called [Gluu Flex](https://gluu.org/flex). | **[Jans KC](jans-keycloak-integration)** | provides an array of out of the box IAM services in a single lightweight container image. It's handy for many workforce requirements like SAML. The Janssen authenticator module (SPI) simplifies SSO across Janssen and Keycloak websites. | ![Incubating](https://img.shields.io/badge/Incubating-%23f79307) | | **[Jans LDAP Link](jans-link)** | a group of components that provide synchronization services to update the Janssen User Store from an external authoritative LDAP data sources | ![Incubating](https://img.shields.io/badge/Incubating-%23f79307) | | **[Jans Keycloak Link](jans-keycloak-link)** | a group of components that provide synchronization services to update the Janssen User Store from an external authoritative Keycloak data sources | ![Incubating](https://img.shields.io/badge/Incubating-%23f79307) | -| **[Jans Lock](jans-lock)** | A Pub/Sub client that retrieves the latest data about OAuth access and transaction tokens and updates OPA. | ![Incubating](https://img.shields.io/badge/Incubating-%23f79307) | +| **[Jans Lock](jans-lock)** | An enterprise authorization solution featuring the Cedarling, a stateless PDP and the Lock Server which centralizes audit logs and configuration. | ![Incubating](https://img.shields.io/badge/Incubating-%23f79307) | | **[Jans Tarp](demos/jans-tarp)** | An OpenID Connect RP test website that runs as a browser plugin in Chrome or Firefox. | ![Incubating](https://img.shields.io/badge/Incubating-%23f79307) | | **[Jans Chip](demos/jans-chip)** | Sample iOS and Android mobile applications that implement the full OAuth and FIDO security stack for app integrity, client constrained access tokens, and user presence. | ![Demo](https://img.shields.io/badge/Demo-%23368af7) | | **[Jans Tent](demos/jans-tent)** | A test Relying Party ("RP") built using Python and Flask. Enables you to send different requests by quickly modifying just one configuration file. | ![Demo](https://img.shields.io/badge/Demo-%23368af7) | ## Installation -You can install Janssen in a Kubernetes cluster or as a single VM. Check out the -[Janssen Documentation](https://docs.jans.io/head/admin/install/) for all -the details. +You can install the Janssen federation stack in a Kubernetes cluster or as a +single VM. Check out the [Janssen Documentation](https://docs.jans.io/head/admin/install/) +for details. ## Community A BIG thanks to all the amazing contributors!! 👏 👏 -Building a diverse community is our number one goal. Please let us know what we +Building a diverse and inclusive community is an important goal. Please let us know what we can do to make you feel more welcome, no matter what you want to contribute. There are many ways you can contribute. Join this amazing team! @@ -162,14 +147,14 @@ Below is the list of current mega releases that hold information about every sin In 2020, [Gluu](https://gluu.org) decided to give contributors a role in the governance and collaborated with the Linux Foundation to charter the Janssen Project. The initial software contribution for the Janssen Project was a fork of -the "Gluu Server". Subsequently, the Janssen Project developers added a new +the Gluu Server version 4. Subsequently, the Janssen Project developers added a new configuration control plane, tools, demos, documentation, packaging and deployment assets. ### Why the name Janssen? -Pigeons (or doves...) are universally regarded as a symbol of peace--which I -think everyone can agree we need more of today. But pigeons are also really fast, +Pigeons (or doves...) are universally regarded as a symbol of peace--which +we need more of today. But pigeons are also really fast, capable of flying 1000 kilometers in a single day, powered by a handful of seeds. The **Janssen brothers of Arendonk** in Belgium bred the world's fastest family of racing pigeons. Janssen racing pigeons revolutionized