Skip to content

Commit

Permalink
Add license and documentation to be included in the repository zip
Browse files Browse the repository at this point in the history
  • Loading branch information
pgier committed Feb 12, 2013
1 parent 73c1c6a commit cf192f8
Show file tree
Hide file tree
Showing 3 changed files with 204 additions and 0 deletions.
8 changes: 8 additions & 0 deletions extra-files/JBossEULA.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
END USER LICENSE AGREEMENT
JBOSS^® ENTERPRISE MIDDLEWARE^TM

The end user license agreement ("EULA") governs the use of the various
software modules that collectively comprise JBoss Enterprise Middleware and
any related updates, source code, appearance, structure and organization,
regardless of the delivery mechanism. The JBoss Enterprise Middleware EULA can
be found here: http://www.redhat.com/licenses/jboss_eula.html
120 changes: 120 additions & 0 deletions extra-files/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
JBoss EAP Maven Repository
==========================

This archive contains Maven repository artifacts for JBoss EAP 6. This is meant
to be used in a development environment for JBoss EAP 6 applications.


Installation (Option 1) - Local File System
--------------------------------

For initial testing in a small team, the repository can be extracted to
a directory on the local file system.

unzip jboss-eap-6.1.X-maven-repository.zip

This will create a Maven repository in a directory called "jboss-eap-6.0-maven-repository".
Make a note of the location of this directory for later use.


Installation (Option 2) - Apache Web Server
--------------------------------

To use the repository in a multi-user environment, the repository can be installed
in a standard webserver such as Apache httpd, or a Maven repository manager such as Nexus.
To install the repository in Apache, simply unzip the repository in a web accessible
directory on the Apache server.

unzip jboss-eap-6.1.X-maven-repository.zip

This will create a Maven repository in a directory called "jboss-eap-6.0-maven-repository".
Apache should then be configured to allow read access and directory browsing in this directory.


Installation (Option 3) - Maven Repository Manager
--------------------------------------------------

If you already use a repository manager, you can use it to host the EAP repository alongside
your existing repositories. Please refer to the documentation for your repository manager,
for example:

* [Apache Archiva](http://archiva.apache.org/)
* [JFrog Artifactory](http://www.jfrog.com/products.php)
* [Sonatype Nexus](http://nexus.sonatype.org/)

Maven Configuration
-------------------

In order to correctly use this repository, the Maven settings (settings.xml) will
need to be updated. A default settings.xml file is included with each Maven distribution
in the "conf" directory. The Maven user settings is normally found in the ".m2" sub-directory
of the user's home directory. For more information about configuring Maven, refer to the
[Maven site](http://maven.apache.org/settings.html).

The URL of the repository will depend on where the
repository is located (i.e. on the filesystem, web server etc). A few example
URLs are provided here:

* File system - file:///path/to/repo/jboss-eap-6.1.X-maven-repository
* Apache Web Server - http://intranet.acme.com/jboss-eap-6.1.X-maven-repository
* Nexus Repository Manager - https://intranet.acme.com/nexus/content/repositories/jboss-eap-6.1.X-maven-repository

An example Maven settings file (example-settings.xml) is included in the root directory of the Maven
repository zip file. An excerpt containing the relevant portions of settings.xml is provided below.
More information about configuring your Maven settings is available on the Apache Maven site.


<settings>
...
<profiles>
...
<profile>
<id>jboss-eap-repository</id>
<repositories>
<repository>
<id>jboss-eap-repository</id>
<name>JBoss EAP Maven Repository</name>
<url>file:///path/to/repo/jboss-eap-6.1.X-maven-repository</url>
<layout>default</layout>
<releases>
<enabled>true</enabled>
<updatePolicy>never</updatePolicy>
</releases>
<snapshots>
<enabled>false</enabled>
<updatePolicy>never</updatePolicy>
</snapshots>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>jboss-eap-repository-group</id>
<name>JBoss EAP Maven Repository</name>
<url>file:///path/to/repo/jboss-eap-6.1.X-maven-repository</url>
<layout>default</layout>
<releases>
<enabled>true</enabled>
<updatePolicy>never</updatePolicy>
</releases>
<snapshots>
<enabled>false</enabled>
<updatePolicy>never</updatePolicy>
</snapshots>
</pluginRepository>
</pluginRepositories>
</profile>

</profiles>

<activeProfiles>
<activeProfile>jboss-eap-repository</activeProfile>
</activeProfiles>
...
</settings>


Project Configuration
---------------------

For more detailed project examples please see the JBoss EAP quickstarts documentation.

76 changes: 76 additions & 0 deletions extra-files/example-settings.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
<?xml version="1.0" encoding="UTF-8"?>

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">

<profiles>

<!-- Configure the JBoss EAP Maven repository -->
<profile>
<id>jboss-eap-repository</id>
<repositories>
<repository>
<id>jboss-eap-repository</id>
<url>file:///path/to/repo/jboss-eap-6.1.X-maven-repository</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>jboss-eap-plugin-repository</id>
<url>file:///path/to/repo/jboss-eap-6.1.X-maven-repository</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
</pluginRepository>
</pluginRepositories>
</profile>

<!-- Configure the JBoss Community Maven repository -->
<profile>
<id>jboss-community-repository</id>
<repositories>
<repository>
<id>jboss-community-repository</id>
<url>http://repository.jboss.org/nexus/content/groups/public/</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>jboss-community-plugin-repository</id>
<url>http://repository.jboss.org/nexus/content/groups/public/</url>
<releases>
<enabled>true</enabled>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
</pluginRepository>
</pluginRepositories>
</profile>

</profiles>

<activeProfiles>
<!-- Optionally, make the repositories active by default -->
<activeProfile>jboss-eap-repository</activeProfile>
<activeProfile>jboss-community-repository</activeProfile>
</activeProfiles>

</settings>

0 comments on commit cf192f8

Please sign in to comment.