Skip to content

Commit 6e4b61c

Browse files
authored
Update README.md (#773)
1 parent 1e06323 commit 6e4b61c

File tree

1 file changed

+8
-44
lines changed

1 file changed

+8
-44
lines changed

README.md

+8-44
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,9 @@
77
[![License](https://img.shields.io/badge/license-CDDL-blue.svg)](https://github.com/OpenIdentityPlatform/OpenAM/blob/master/LICENSE.md)
88
[![Downloads](https://img.shields.io/github/downloads/OpenIdentityPlatform/OpenAM/total.svg)](https://github.com/OpenIdentityPlatform/OpenAM/releases)
99
[![Docker](https://img.shields.io/docker/pulls/openidentityplatform/openam.svg)](https://hub.docker.com/r/openidentityplatform/openam)
10-
[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/OpenIdentityPlatform/OpenAM)
1110
[![Top language](https://img.shields.io/github/languages/top/OpenIdentityPlatform/OpenAM.svg)](https://github.com/OpenIdentityPlatform/OpenAM)
1211
[![Code size in bytes](https://img.shields.io/github/languages/code-size/OpenIdentityPlatform/OpenAM.svg)](https://github.com/OpenIdentityPlatform/OpenAM)
1312

14-
# Project Overview
15-
1613
Open Access Management (OpenAM) is an access management solution that includes Authentication, SSO, Authorization, Federation, Entitlements, and Web Services Security.
1714

1815
Cross Domain Single Sign On (CDSSO), SAML 2.0, OAuth 2.0 & OpenID Connect ensure that OpenAM integrates easily with legacy, custom, and cloud applications without requiring any modifications.
@@ -48,9 +45,6 @@ This project is licensed under the [Common Development and Distribution License
4845
* [OpenAM Web Policy Agent Apache 2.4](https://github.com/OpenIdentityPlatform/OpenAM-Web-Agents#downloads) (Linux x64)
4946
* [OpenAM Web Policy Agent (IIS Windows x32/x64 ZIP)](https://ci.appveyor.com/api/buildjobs/cnebrw2f43my9vxr/artifacts/IIS_WINNT_4.1.0.zip)
5047

51-
52-
**[OpenAM Quick Start Guide](https://github.com/OpenIdentityPlatform/OpenAM/wiki/Quick-Start-Guide)**
53-
5448
## How-to Build OpenAM from Source
5549
To build OpenAM from source you should use JDK 8 or higher
5650

@@ -77,49 +71,19 @@ Run OpenAM from source:
7771
mvn cargo:run -f OpenAM/openam-server
7872
```
7973

80-
The next step is then to go to [http://login.domain.com:8080/openam](http://login.domain.com:8080/openam) where you'll see the OpenAM welcome page
81-
82-
---
83-
**Important Note**
84-
85-
You must allocate at least 1024m (2048m with embedded OpenDJ) heap memory for OpenAM JVM using -Xmx option.
86-
87-
For example, `-Xmx2048m`
88-
89-
---
90-
91-
## How To Guides
92-
93-
* [Config OpenAM as OAuth2 Service Provider](https://github.com/OpenIdentityPlatform/OpenAM/wiki/Config-OpenAM-as-OAuth2-Service-Provider)
94-
* [How to Add Authorization and Protect Your Application With OpenAM and OpenIG Stack](https://github.com/OpenIdentityPlatform/OpenAM/wiki/How-to-Add-Authorization-and-Protect-Your-Application-With-OpenAM-and-OpenIG-Stack)
95-
* [How to Customise OpenAM](https://github.com/OpenIdentityPlatform/OpenAM/wiki/How-to-Customise-OpenAM)
96-
* [How to disable XUI by default](https://github.com/OpenIdentityPlatform/OpenAM/wiki/How-to-disable-XUI-by-default)
97-
* [How to make OpenAM log more verbose](https://github.com/OpenIdentityPlatform/OpenAM/wiki/How-to-make-OpenAM-log-more-verbose)
98-
* [How To Run OpenAM in Kubernetes](https://github.com/OpenIdentityPlatform/OpenAM/wiki/How-To-Run-OpenAM-in-Kubernetes)
99-
* [How to Setup 2FA with Google Authenticator in OpenAM](https://github.com/OpenIdentityPlatform/OpenAM/wiki/How-to-Setup-2FA-with-Google-Authenticator-in-OpenAM)
100-
* [How To Setup Active Directory Authentication In OpenAM](https://github.com/OpenIdentityPlatform/OpenAM/wiki/How-To-Setup-Active-Directory-Authentication-In-OpenAM)
101-
* [How to setup Kerberos Authentication with OpenAM](https://github.com/OpenIdentityPlatform/OpenAM/wiki/How-to-setup-Kerberos-Authentication-with-OpenAM)
102-
* [How to Setup WebAuthn Authentication in OpenAM](https://github.com/OpenIdentityPlatform/OpenAM/wiki/How-to-Setup-WebAuthn-Authentication-in-OpenAM)
103-
* [How to Start OpenAM and OpenDJ in Separate Docker Contaners](https://github.com/OpenIdentityPlatform/OpenAM/wiki/How-to-Start-OpenAM-and-OpenDJ-in-Separate-Docker-Contaners)
104-
* [How to Use Apache Cassandra as User DataStore in OpenAM](https://github.com/OpenIdentityPlatform/OpenAM/wiki/How-to-Use-Apache-Cassandra-as-User-DataStore-in-OpenAM)
105-
* [Migrate OpenAM to Apache Cassandra without Single Point of Failure](https://github.com/OpenIdentityPlatform/OpenAM/wiki/Migrate-OpenAM-to-Apache-Cassandra-without-Single-Point-of-Failure)
106-
* [OpenAM Monitoring Using Prometheus](https://github.com/OpenIdentityPlatform/OpenAM/wiki/OpenAM-Monitoring-Using-Prometheus)
107-
* [Creating a Custom Authentication Module](https://github.com/OpenIdentityPlatform/OpenAM/wiki/Write-a-custom-authentication-module)
74+
The next step is then to go to [http://login.domain.com:8080/openam](http://login.domain.com:8080/openam) where you'll see the OpenAM welcome
10875

10976

110-
## Support and Mailing List Information
111-
* OpenAM Community Wiki: https://github.com/OpenIdentityPlatform/OpenAM/wiki
112-
* OpenAM Community Discussions: https://github.com/OpenIdentityPlatform/OpenIG/discussions
113-
* OpenAM Community Archive: https://groups.google.com/d/forum/open-identity-platform-openam
114-
* OpenAM Community on Gitter: https://gitter.im/OpenIdentityPlatform/OpenAM
115-
* OpenAM Community Mailing List: [email protected]
116-
* OpenAM Commercial support RFP: [email protected] (English, Russian)
77+
## Support
78+
* OpenAM Community [documentation](https://github.com/OpenIdentityPlatform/OpenAM/wiki)
79+
* OpenAM Community [discussions](https://github.com/OpenIdentityPlatform/OpenAM/discussions)
80+
* OpenAM Community [issues](https://github.com/OpenIdentityPlatform/OpenAM/issues)
81+
* OpenAM [commercial support](https://github.com/OpenIdentityPlatform/.github/wiki/Approved-Vendor-List)
11782

11883
## Contributing
11984
Please, make [Pull request](https://github.com/OpenIdentityPlatform/OpenAM/pulls)
12085

121-
## Thanks for OpenAM
122-
* Sun Access Manager
123-
* Sun OpenSSO
86+
## Thanks 🥰
87+
* Sun Access Manager/OpenSSO
12488
* Oracle OpenSSO
12589
* Forgerock OpenAM

0 commit comments

Comments
 (0)