https://github.com/sonatype-nexus-community/nexus-repository-cargo
Nexus Repository Cargo Format
https://github.com/sonatype-nexus-community/nexus-repository-cargo
cargo nexus3
Last synced: 3 months ago
JSON representation
Nexus Repository Cargo Format
- Host: GitHub
- URL: https://github.com/sonatype-nexus-community/nexus-repository-cargo
- Owner: sonatype-nexus-community
- License: epl-1.0
- Created: 2019-01-11T17:42:03.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-06-05T16:26:00.000Z (over 1 year ago)
- Last Synced: 2025-06-30T08:07:54.643Z (4 months ago)
- Topics: cargo, nexus3
- Language: Java
- Homepage:
- Size: 127 KB
- Stars: 69
- Watchers: 14
- Forks: 18
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Nexus Repository Cargo Format
[](https://maven-badges.herokuapp.com/maven-central/org.sonatype.nexus.plugins/nexus-repository-cargo)
[](https://circleci.com/gh/sonatype-nexus-community/nexus-repository-cargo)
[](https://gitter.im/sonatype/nexus-developers?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://depshield.github.io)
## Developing
### Requirements
* [Apache Maven 3.3.3+](https://maven.apache.org/install.html)
* [Java 8](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)
* Network access to https://repository.sonatype.org/content/groups/sonatype-public-grid
Also, there is a good amount of information available at [Bundle Development](https://help.sonatype.com/display/NXRM3/Bundle+Development)
### Building
To build the project and generate the bundle use Maven
mvn clean package
If everything checks out, the bundle for cargo should be available in the `target` folder
#### Build with Docker
`docker build -t nexus-repository-cargo .`
#### Run as a Docker container
`docker run -d -p 8081:8081 --name nexus-repository-cargo nexus-repository-cargo`
For further information like how to persist volumes check out [the GitHub repo for our official image](https://github.com/sonatype/docker-nexus3).
After allowing some time to spin up, the application will be available from your browser at http://localhost:8081.
To read the generated admin password for your first login to the web UI, you can use the command below against the running docker container:
docker exec -it nexus-repository-cargo cat /nexus-data/admin.password && echo
For simplicity, you should check `Enable anonymous access` in the prompts following your first login.
## Using Cargo With Nexus Repository Manager 3
[We have detailed instructions on how to get started here!](docs/CARGO_USER_DOCUMENTATION.md)
## Compatibility with Nexus Repository Manager 3 Versions
The table below outlines what version of Nexus Repository the plugin was built against
| Plugin Version | Nexus Repository Version |
|----------------|--------------------------|
| v0.0.1 | 3.12.0-01 |
| v0.0.1 | 3.29.2-02 |
| v0.0.2 | 3.30.1-01 |
| v0.0.4 | 3.40.1-01 |
| v0.0.8 | 3.66.0-02 |
If a new version of Nexus Repository is released and the plugin needs changes, a new release will be made, and this
table will be updated to indicate which version of Nexus Repository it will function against. This is done on a time
available basis, as this is community supported. If you see a new version of Nexus Repository, go ahead and update the
plugin and send us a PR after testing it out!
All released versions can be found [here](https://github.com/sonatype-nexus-community/nexus-repository-cargo/releases).
## Features Implemented In This Plugin
| Feature | Implemented |
|---------|----------------------|
| Proxy | |
| Hosted | |
| Group | |
### Supported Cargo Commands
#### Proxy
Command | Plugin Version | Implemented |
--------|------------------------------|--------------------------|
login | | |
search | | |
fetch | | |
publish | | |
yank | | |
#### Hosted
Command | Plugin Version | Implemented |
--------|------------------------------|--------------------------|
login | | |
search | | |
fetch | | |
publish | | |
yank | | |
## Installing the plugin
You'll need to build it first, copy the kar file into `/deploy`:
```
$ cp nexus-repository-cargo--bundle.kar /deploy/
```
and then start Nexus.
## The Fine Print
It is worth noting that this is **NOT SUPPORTED** by Sonatype, and is a contribution of ours and Imperva 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 cargo 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](https://gitter.im/sonatype/nexus-developers)
* Check out the [Nexus3](http://stackoverflow.com/questions/tagged/nexus3) tag on Stack Overflow
* Check out the [Nexus Repository User List](https://groups.google.com/a/glists.sonatype.com/forum/?hl=en#!forum/nexus-users)