Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[13.x] Update Readme #40

Open
wants to merge 1 commit into
base: sustaining/13.x
Choose a base branch
from
Open

[13.x] Update Readme #40

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 31 additions & 43 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,65 +1,54 @@
# wren:AM
# Wren:AM
[Wiki](https://github.com/WrenSecurity/wrenam/wiki) \|
[Google Groups **Mailing List**](https://groups.google.com/forum/#!forum/wren-security) \|
[Gitter **Chat**](https://gitter.im/WrenSecurity/Lobby)
[![CDDL-licensed](https://img.shields.io/badge/license-CDDL-blue.svg)](license)
[![Build Status](https://semaphoreci.com/api/v1/wrensecurity/wrenam/branches/sustaining-13-x/badge.svg)](https://semaphoreci.com/wrensecurity/wrenam)
[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/WrenSecurity/wrenam.svg)](http://isitmaintained.com/project/WrenSecurity/wrenam "Average time to resolve an issue")
[![Percentage of issues still open](http://isitmaintained.com/badge/open/WrenSecurity/wrenam.svg)](http://isitmaintained.com/project/WrenSecurity/wrenam "Percentage of issues still open")

[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/WrenSecurity/Lobby)

wren:am is a CDDL-licensed, community fork of ForgeRock's OpenAM product. Though our project originated with code that ForgeRock previously released, we are not affiliated with ForgeRock in any way.
Wren:AM is a CDDL-licensed, community fork of ForgeRock's OpenAM product. Though our project originated with code that ForgeRock previously released, we are not affiliated with ForgeRock in any way.

ForgeRock no longer releases any of the most recent versions of their software under an open-source license. ForgeRock’s “Community Edition” versions are much older versions then their commercial offerings. Join our community for the latest and greatest.

See [wrensecurity.org](http://wrensecurity.org/) for more information.

## Preparing your build environment
See [wrensecurity.org](https://wrensecurity.org/) and [timeforafork.com](http://www.timeforafork.com/) for more information.

In order to build wren:AM from source you need the following software installed:
## Preparing Your Build Environment
In order to build Wren:AM from source you need the following software installed:

* Java (OpenJDK) >= 1.7
* Apache Maven >= 3.1.0

## Building wren:AM
## About This Branch (`sustaning/13.x`)
The `sustaining/13.x` branch is a stable branch, intended for bug and security fixes against versions of Wren:AM that were originally part of ForgeRock's OpenAM 13.0 major-point release. You will *not* find any of the features or enhancements from AM 13.5 in this branch (see `sustaining/13.5.x` for those).

wren:am is fully build-able, however currently not all required artifacts (dependencies) are deployed to public artifact repositories. Therefor there are 2 repositories which you need to clone to install all required artifacts in to your local `~/.m2/repository` location. Our current progress on getting all artifacts in public repositories with verifiable sources can be tracked in this [Google spreadsheet](https://docs.google.com/spreadsheets/d/1HUEprS3Mdm7vxtkPhGu8UYVh0U5V9j1p-dj0bXYhGOs/edit?usp=sharing).
## Building Wren:AM
Wren:AM is fully buildable from source.

```
$ git clone https://github.com/WrenSecurity/wrensec-deps.git
$ pushd wrensec-deps
$ ./install_wrenam_13_deps.sh
$ popd
```
```
$ git clone https://github.com/WrenSecurity/forgerock-xui-deps.git
$ pushd forgerock-xui-deps
$ git checkout sustaining/13
$ ./install.sh
$ popd
```
**If you have previously built OpenAM or other ForgeRock products from source, you are strongly encouraged to clear your local `~/.m2/repository` before building Wren:AM for the first time.**

This step is necessary because Wren artifacts in this version of AM have the same Maven artifact IDs that ForgeRock originally used for the corresponding artifacts, but our copies contain modifications to source from our Maven repositories. This was necessary because ForgeRock's repositories are no longer publicly accessible.

After installing all required artifacts, clone the `wrenam` repository and checkout the `sustaining/13` branch:
After clearing your local repository of conflicting ForgeRock artifacts, clone the `wrenam` repository and checkout the `sustaining/13.x` branch:

```
$ git clone https://github.com/WrenSecurity/wrenam.git
$ git clone -b sustaining/13.x https://github.com/WrenSecurity/wrenam.git
$ cd wrenam
$ git checkout -b sustaining/13 origin/sustaining/13
$ mvn clean install
```

## Contributing
## How and Why to Contribute
Contributing to Wren:AM is easy! Please review our [contributor guidelines](https://github.com/WrenSecurity/wrensec-docs/wiki/Contributor-Guidelines).

Contributing to wren:AM is easy! Just create a GitHub pull request!
By contributing, you are helping to shape Wren:AM to meet your needs. Your contributions make the product more secure, more robust, and more flexible -- for your needs now, and other's needs in the future. If you find a bug, or have an enhancement request, consider contributing toward a solution. Every PR helps.

We do however ask that you run the `precommit` Maven profile which checks your codestyle among things.
## Past and Current Contributors
Wren:AM is a joint effort between _developers like you_, and the following Wren Security member organizations:
- [Orchitech Solutions, s.r.o.](https://orchi.tech/)

```
$ mvn clean install -P precommit
```

Some legacy code will fail, so if you are modifying an existing module you should run this profile before modifying the code, and then run the profile again after modifications to ensure the number of reported issues has not increased.

## Authors

See the list of [contributors][contributors] who participated in this project.
See the full list of [contributors](https://github.com/WrenSecurity/wrenam/graphs/contributors) who have participated in this project so far.

## License

This project is licensed under the Common Development and Distribution License (CDDL). The following text applies to both this file, and should also be included in all files in the project:

> The contents of this file are subject to the terms of the Common Development and Distribution License (the License).
Expand All @@ -72,14 +61,13 @@ This project is licensed under the Common Development and Distribution License (
> legal/CDDLv1.0.txt. If applicable, add the following below the CDDL Header, with the fields enclosed by brackets []
> replaced by your own identifying information: "Portions copyright [year] [name of copyright owner]".
>
> Copyright 2016 ForgeRock AS.
> Copyright 2017-2018 Wren Security.

## Acknowledgments

The WrenSecurity community acknowledges the contributions made to the original OpenSSO and OpenAM products on which Wren:AM is based by the following organisations:
The Wren Security team acknowledges the contributions made to the original OpenSSO and OpenAM products on which Wren:AM is based by the following organizations:

* Sun Microsystems
* Oracle
* ForgeRock

Although the WrenSecurity community acknowledges their contributions the above organisations are in no way affiliated with the WrenSecurity community, Wren:AM or any other WrenSecurity product.
Although the Wren Security team acknowledges their contributions, the above organizations are in no way affiliated with Wren Security, Wren:AM, or any other Wren Security project.