{"id":15056582,"url":"https://github.com/sonatype-nexus-community/nexus-repository-composer","last_synced_at":"2025-05-16T07:06:51.436Z","repository":{"id":38355817,"uuid":"122369264","full_name":"sonatype-nexus-community/nexus-repository-composer","owner":"sonatype-nexus-community","description":"Composer support for the Nexus Repository Manager (work in progress!)","archived":false,"fork":false,"pushed_at":"2025-01-07T22:10:05.000Z","size":301,"stargazers_count":234,"open_issues_count":74,"forks_count":87,"subscribers_count":28,"default_branch":"master","last_synced_at":"2025-04-08T17:17:36.019Z","etag":null,"topics":["composer","groovy","java","nexus-repository","nexus-repository-manager","php","sonatype"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"epl-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sonatype-nexus-community.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-02-21T17:30:12.000Z","updated_at":"2025-04-07T16:05:47.000Z","dependencies_parsed_at":"2024-10-12T19:02:01.614Z","dependency_job_id":"b72e30f8-388a-4492-b5ff-62d6ba6083f6","html_url":"https://github.com/sonatype-nexus-community/nexus-repository-composer","commit_stats":{"total_commits":139,"total_committers":26,"mean_commits":5.346153846153846,"dds":0.525179856115108,"last_synced_commit":"80fbc8748d923dc406680360ac0b90c7cac20b9c"},"previous_names":[],"tags_count":37,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sonatype-nexus-community%2Fnexus-repository-composer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sonatype-nexus-community%2Fnexus-repository-composer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sonatype-nexus-community%2Fnexus-repository-composer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sonatype-nexus-community%2Fnexus-repository-composer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sonatype-nexus-community","download_url":"https://codeload.github.com/sonatype-nexus-community/nexus-repository-composer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254485066,"owners_count":22078767,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["composer","groovy","java","nexus-repository","nexus-repository-manager","php","sonatype"],"created_at":"2024-09-24T21:53:41.439Z","updated_at":"2025-05-16T07:06:46.406Z","avatar_url":"https://github.com/sonatype-nexus-community.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!--\n\n    Sonatype Nexus (TM) Open Source Version\n    Copyright (c) 2018-present Sonatype, Inc.\n    All rights reserved. Includes the third-party code listed at https://www.sonatype.com/usage/attributions.\n\n    This program and the accompanying materials are made available under the terms of the Eclipse Public License Version 1.0,\n    which accompanies this distribution and is available at https://www.eclipse.org/legal/epl/epl-v10.html.\n\n    Sonatype Nexus (TM) Professional Version is available from Sonatype, Inc. \"Sonatype\" and \"Sonatype Nexus\" are trademarks\n    of Sonatype, Inc. Apache Maven is a trademark of the Apache Software Foundation. M2eclipse is a trademark of the\n    Eclipse Foundation. All other trademarks are the property of their respective owners.\n\n--\u003e\n# Nexus Repository Composer Format\n\n[![Maven Central](https://img.shields.io/maven-central/v/org.sonatype.nexus.plugins/nexus-repository-composer.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22org.sonatype.nexus.plugins%22%20AND%20a:%22nexus-repository-composer%22) \n[![CircleCI](https://circleci.com/gh/sonatype-nexus-community/nexus-repository-composer.svg?style=shield)](https://circleci.com/gh/sonatype-nexus-community/nexus-repository-composer)\n[![Join the chat at https://gitter.im/sonatype/nexus-developers](https://badges.gitter.im/sonatype/nexus-developers.svg)](https://gitter.im/sonatype/nexus-developers?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\n# Table Of Contents\n* [Developing](#developing)\n   * [Requirements](#requirements)\n   * [Building](#building)\n* [Using Composer with Nexus Repository Manger 3](#using-composer-with-nexus-repository-manager-3)\n* [Installing the plugin](#installing-the-plugin)\n   * [Easiest Install](#easiest-install)\n   * [Temporary Install](#temporary-install)\n   * [(more) Permanent Install](#more-permanent-install)\n   * [(most) Permament Install](#most-permanent-install)\n* [The Fine Print](#the-fine-print)\n* [Getting Help](#getting-help)\n* [Composer Plugin](#composer-plugin)\n\n## Developing\n\n### Requirements\n\n* [Apache Maven 3.3.3+](https://maven.apache.org/install.html)\n* [Java 17](https://adoptium.net/de/temurin/releases/?version=17) (recommended, also compatible with [Java 11](https://adoptium.net/de/temurin/releases/?version=11) and [Java 8](https://adoptium.net/de/temurin/releases/?version=8))\n* Network access to https://repository.sonatype.org/content/groups/sonatype-public-grid\n\nAlso, there is a good amount of information available at [Bundle Development](https://help.sonatype.com/display/NXRM3/Bundle+Development)\n\n### Building\n\nTo build the project and generate the bundle use Maven\n\n    mvn clean package\n\nIf everything checks out, the bundle for Composer should be available in the `target` folder\n\n#### Build with Docker\n\n    docker build -t nexus-repository-composer .\n\n#### Run as a Docker container\n\n    docker run -d -p 8081:8081 --name nexus-repository-composer nexus-repository-composer \n\nFor further information like how to persist volumes check out [the GitHub repo for our official image](https://github.com/sonatype/docker-nexus3).\n\nThe application will now be available from your browser at http://localhost:8081\n\n* As of Nexus Repository Manager Version 3.17, the default admin password is randomly generated.\n  If running in a Docker container, you will need to view the generated password file \n  (/nexus-data/admin.password) in order to login to Nexus. The command below will open a bash shell \n  in the container named `nexus-repository-composer`:\n\n      docker exec -it nexus-repository-composer /bin/bash\n      $ cat /nexus-data/admin.password \n      \n  Once logged into the application UI as `admin` using the generated password, you should also \n  turn on \"Enable anonymous access\" when prompted by the setup wizard.     \n\n## Using Composer With Nexus Repository Manager 3\n\n[We have detailed instructions on how to get started here!](docs/COMPOSER_USER_DOCUMENTATION.md)\n\n\u003e **_Nexus Repository Composer_ 0.1+ is only compatible with _Nexus Repository Manager_ 3.71 or later**\n\u003e\n\u003e Use 0.0.x for older NXRM installations.\n\n## Installing the plugin\n\nThere are a range of options for installing the Composer plugin. You'll need to build it first, and\nthen install the plugin with the options shown below:\n\n### Easiest Install\n\nThanks 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:\n\n#### Option 1: Build a *.kar file locally from the GitHub Repo\n* Clone this repo and `cd` to the cloned directory location\n* Build the plugin with `mvn clean package -PbuildKar`\n* There should now be a `nexus-repository-composer-\u003cversion\u003e-bundle.kar` file in your `\u003ccloned_repo\u003e/target` directory \n\n#### Option 2: Download a *.kar file from The Central Repository \n* Download `nexus-repository-composer-\u003cversion\u003e-bundle.kar` from [The Central Repository](https://search.maven.org/artifact/org.sonatype.nexus.plugins/nexus-repository-composer)\n\nOnce you've completed Option 1 or 2, copy the `nexus-repository-composer-\u003cversion\u003e-bundle.kar` file into the `\u003cnexus_dir\u003e/deploy` folder for your Nexus Repository installation.\n\nRestart Nexus Repo, or go ahead and start it if it wasn't running to begin with.\n\nYou 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 :)\n\n### Temporary Install\n\nInstallations done via the Karaf console will be wiped out with every restart of Nexus Repository. This is a\ngood installation path if you are just testing or doing development on the plugin.\n\n* Enable the NXRM console: edit `\u003cnexus_dir\u003e/bin/nexus.vmoptions` and change `karaf.startLocalConsole`  to `true`.\n\n  More details here: [Bundle Development](https://help.sonatype.com/en/bundle-development.html)\n\n* Run NXRM's console:\n  ```\n  # sudo su - nexus\n  $ cd \u003cnexus_dir\u003e/bin\n  $ ./nexus run\n  \u003e bundle:install file:///tmp/nexus-repository-composer-0.1.0.jar\n  \u003e bundle:list\n  ```\n  (look for org.sonatype.nexus.plugins:nexus-repository-composer ID, should be the last one)\n  ```\n  \u003e bundle:start \u003corg.sonatype.nexus.plugins:nexus-repository-composer ID\u003e\n  ```\n\n### (more) Permanent Install\n\nFor more permanent installs of the nexus-repository-composer plugin, follow these instructions:\n\n* Copy the bundle (nexus-repository-composer-0.1.0.jar) into \u003cnexus_dir\u003e/deploy\n\nThis will cause the plugin to be loaded with each restart of Nexus Repository. As well, this folder is monitored\nby Nexus Repository and the plugin should load within 60 seconds of being copied there if Nexus Repository\nis running. You will still need to start the bundle using the karaf commands mentioned in the temporary install.\n\n### (most) Permanent Install\n\nIf you are trying to use the Composer plugin permanently, it likely makes more sense to do the following:\n\n* Copy the bundle into `\u003cnexus_dir\u003e/system/org/sonatype/nexus/plugins/nexus-repository-composer/0.1.0/nexus-repository-composer-0.1.0.jar`\n* Make the following additions marked with + to `\u003cnexus_dir\u003e/system/org/sonatype/nexus/assemblies/nexus-core-feature/3.x.y/nexus-core-feature-3.x.y-features.xml`\n\n   ```\n         \u003cfeature prerequisite=\"false\" dependency=\"false\"\u003ewrap\u003c/feature\u003e\n   +     \u003cfeature prerequisite=\"false\" dependency=\"false\"\u003enexus-repository-composer\u003c/feature\u003e\n   ```\n   to the `\u003cfeature name=\"nexus-core-feature\" description=\"org.sonatype.nexus.assemblies:nexus-core-feature\" version=\"3.x.y.xy\"\u003e` section below the last \u003cfeature prerequisite...\u003e (above is an example, the exact last one may vary).\n\n   And    \n   ```\n   + \u003cfeature name=\"nexus-repository-composer\" description=\"org.sonatype.nexus.plugins:nexus-repository-composer\" version=\"0.1.0\"\u003e\n   +     \u003cdetails\u003eorg.sonatype.nexus.plugins:nexus-repository-composer\u003c/details\u003e\n   +     \u003cbundle\u003emvn:org.sonatype.nexus.plugins/nexus-repository-composer/0.1.0\u003c/bundle\u003e\n   + \u003c/feature\u003e\n    \u003c/features\u003e\n   ```\n   as the last feature.\n\nThis will cause the plugin to be loaded and started with each startup of Nexus Repository.\n\n## The Fine Print\n\nIt is worth noting that this is **NOT SUPPORTED** by Sonatype, and is a contribution of ours\nto the open source community (read: you!)\n\nRemember:\n\n* Use this contribution at the risk tolerance that you have\n* Do NOT file Sonatype support tickets related to Composer support in regard to this plugin\n* DO file issues here on GitHub, so that the community can pitch in\n\nPhew, that was easier than I thought. Last but not least of all:\n\nHave fun creating and using this plugin and the Nexus platform, we are glad to have you here!\n\n## Getting help\n\nLooking to contribute to our code but need some help? There's a few ways to get information:\n\n* Chat with us on [Gitter](https://gitter.im/sonatype/nexus-developers)\n* Check out the [Nexus3](https://stackoverflow.com/questions/tagged/nexus3) tag on Stack Overflow\n* Check out the [Nexus Repository User List](https://groups.google.com/a/glists.sonatype.com/g/nexus-users)\n\n## Composer Plugin\nThe 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.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsonatype-nexus-community%2Fnexus-repository-composer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsonatype-nexus-community%2Fnexus-repository-composer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsonatype-nexus-community%2Fnexus-repository-composer/lists"}