Nexus Repository Protop Format

Table Of Contents

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

Developing

Requirements

• Apache Maven 3.3.3+
• 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 install

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

Using protop With Nexus Repository Manager 3

We have detailed instructions on how to get started here!

Installing the plugin

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

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 Nexus console: edit <nexus_dir>/bin/nexus.vmoptions and change karaf.startLocalConsole to true.

  More details here: Bundle Development

• Run Nexus' console:

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

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

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

(more) Permanent Install

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

• Copy the bundle (nexus-repository-protop-1.0.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 protop plugin permanently, it likely makes more sense to do the following:

• Copy the bundle into <nexus_dir>/system/org/sonatype/nexus/plugins/nexus-repository-protop/1.0.0/nexus-repository-protop-1.0.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">nexus-repository-rubygems</feature>
  +     <feature prerequisite="false" dependency="false">nexus-repository-protop</feature>
        <feature prerequisite="false" dependency="false">nexus-repository-gitlfs</feature>
    </feature>
  

  And

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

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 protop 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 or Contributing

Looking to contribute to our code but need some help or have an issue? Please reach out on Github either through the issue tracker or pull request, or via email (info@protop.io).