Nexus Repository Composer Format

Table Of Contents

• Developing
  • Requirements
  • Building
• Using Composer with Nexus Repository Manger 3
• Installing the plugin
  • Easiest Install
  • Temporary Install
  • (more) Permanent Install
  • (most) Permament Install
• The Fine Print
• Getting Help
• Composer Plugin

Developing

Requirements

• Apache Maven 3.3.3+
• Java 17 (recommended, also compatible with Java 11 and Java 8)
• Network access to https://repository.sonatype.org/content/groups/sonatype-public-grid

Also, there is a good amount of information available at Bundle Development

Building

To build the project and generate the bundle use Maven

mvn clean package

If everything checks out, the bundle for Composer should be available in the target folder

Build with Docker

docker build -t nexus-repository-composer .

Run as a Docker container

docker run -d -p 8081:8081 --name nexus-repository-composer nexus-repository-composer 

For further information like how to persist volumes check out the GitHub repo for our official image.

The application will now be available from your browser at http://localhost:8081

• As of Nexus Repository Manager Version 3.17, the default admin password is randomly generated. If running in a Docker container, you will need to view the generated password file (/nexus-data/admin.password) in order to login to Nexus. The command below will open a bash shell in the container named nexus-repository-composer:

  docker exec -it nexus-repository-composer /bin/bash
  $ cat /nexus-data/admin.password 
  

  Once logged into the application UI as admin using the generated password, you should also turn on "Enable anonymous access" when prompted by the setup wizard.

Using Composer With Nexus Repository Manager 3

We have detailed instructions on how to get started here!

Nexus Repository Composer 0.1+ is only compatible with Nexus Repository Manager 3.71 or later

Use 0.0.x for older NXRM installations.

Installing the plugin

There are a range of options for installing the Composer plugin. You'll need to build it first, and then install the plugin with the options shown below:

Easiest Install

Thanks to some upstream work in Nexus Repository (versions newer than 3.15), it's become a LOT easier to install a plugin. To install this format plugin, you can either build locally or download from The Central Repository:

Option 1: Build a *.kar file locally from the GitHub Repo

• Clone this repo and cd to the cloned directory location
• Build the plugin with mvn clean package -PbuildKar
• There should now be a nexus-repository-composer-<version>-bundle.kar file in your <cloned_repo>/target directory

Option 2: Download a *.kar file from The Central Repository

• Download nexus-repository-composer-<version>-bundle.kar from The Central Repository

Once you've completed Option 1 or 2, copy the nexus-repository-composer-<version>-bundle.kar file into the <nexus_dir>/deploy folder for your Nexus Repository installation.

Restart Nexus Repo, or go ahead and start it if it wasn't running to begin with.

You should see the new repository types (e.g. composer (hosted, proxy, group)) in the available Repository Recipes to use, if all has gone according to plan :)

Temporary Install

Installations done via the Karaf console will be wiped out with every restart of Nexus Repository. This is a good installation path if you are just testing or doing development on the plugin.

• Enable the NXRM console: edit <nexus_dir>/bin/nexus.vmoptions and change karaf.startLocalConsole to true.

  More details here: Bundle Development

• Run NXRM's console:

  # sudo su - nexus
  $ cd <nexus_dir>/bin
  $ ./nexus run
  > bundle:install file:///tmp/nexus-repository-composer-0.1.0.jar
  > bundle:list
  

  (look for org.sonatype.nexus.plugins:nexus-repository-composer ID, should be the last one)

  > bundle:start <org.sonatype.nexus.plugins:nexus-repository-composer ID>
  

(more) Permanent Install

For more permanent installs of the nexus-repository-composer plugin, follow these instructions:

• Copy the bundle (nexus-repository-composer-0.1.0.jar) into <nexus_dir>/deploy

This will cause the plugin to be loaded with each restart of Nexus Repository. As well, this folder is monitored by Nexus Repository and the plugin should load within 60 seconds of being copied there if Nexus Repository is running. You will still need to start the bundle using the karaf commands mentioned in the temporary install.

(most) Permanent Install

If you are trying to use the Composer plugin permanently, it likely makes more sense to do the following:

• Copy the bundle into <nexus_dir>/system/org/sonatype/nexus/plugins/nexus-repository-composer/0.1.0/nexus-repository-composer-0.1.0.jar

• Make the following additions marked with + to <nexus_dir>/system/org/sonatype/nexus/assemblies/nexus-core-feature/3.x.y/nexus-core-feature-3.x.y-features.xml

        <feature prerequisite="false" dependency="false">wrap</feature>
  +     <feature prerequisite="false" dependency="false">nexus-repository-composer</feature>
  

  to the <feature name="nexus-core-feature" description="org.sonatype.nexus.assemblies:nexus-core-feature" version="3.x.y.xy"> section below the last (above is an example, the exact last one may vary).

  And

  + <feature name="nexus-repository-composer" description="org.sonatype.nexus.plugins:nexus-repository-composer" version="0.1.0">
  +     <details>org.sonatype.nexus.plugins:nexus-repository-composer</details>
  +     <bundle>mvn:org.sonatype.nexus.plugins/nexus-repository-composer/0.1.0</bundle>
  + </feature>
   </features>
  

  as the last feature.

This will cause the plugin to be loaded and started with each startup of Nexus Repository.

The Fine Print

It is worth noting that this is NOT SUPPORTED by Sonatype, and is a contribution of ours to the open source community (read: you!)

Remember:

• Use this contribution at the risk tolerance that you have
• Do NOT file Sonatype support tickets related to Composer support in regard to this plugin
• DO file issues here on GitHub, so that the community can pitch in

Phew, that was easier than I thought. Last but not least of all:

Have fun creating and using this plugin and the Nexus platform, we are glad to have you here!

Getting help

Looking to contribute to our code but need some help? There's a few ways to get information:

• Chat with us on Gitter
• Check out the Nexus3 tag on Stack Overflow
• Check out the Nexus Repository User List

Composer Plugin

The composer plugin elendev/nexus-composer-push (https://github.com/Elendev/nexus-composer-push) provide a composer command to push to a Nexus Repository using this plugin.