{"id":22022329,"url":"https://github.com/sonatype-nexus-community/sonatype-platform-reference","last_synced_at":"2025-05-07T06:43:30.059Z","repository":{"id":37082135,"uuid":"233132994","full_name":"sonatype-nexus-community/sonatype-platform-reference","owner":"sonatype-nexus-community","description":"Docker Compose project for demo's / testing / training","archived":false,"fork":false,"pushed_at":"2025-03-18T14:20:55.000Z","size":71002,"stargazers_count":7,"open_issues_count":3,"forks_count":17,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-03-31T07:22:26.521Z","etag":null,"topics":["docker-compose","sonatype","sonatype-iq","sonatype-lifecycle","sonatype-nexus"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","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":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-01-10T21:25:57.000Z","updated_at":"2025-03-18T14:20:58.000Z","dependencies_parsed_at":"2024-10-18T07:17:21.836Z","dependency_job_id":null,"html_url":"https://github.com/sonatype-nexus-community/sonatype-platform-reference","commit_stats":null,"previous_names":["sonatype-nexus-community/sonatype-platform-reference"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sonatype-nexus-community%2Fsonatype-platform-reference","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sonatype-nexus-community%2Fsonatype-platform-reference/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sonatype-nexus-community%2Fsonatype-platform-reference/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sonatype-nexus-community%2Fsonatype-platform-reference/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sonatype-nexus-community","download_url":"https://codeload.github.com/sonatype-nexus-community/sonatype-platform-reference/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252831176,"owners_count":21810779,"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":["docker-compose","sonatype","sonatype-iq","sonatype-lifecycle","sonatype-nexus"],"created_at":"2024-11-30T06:20:02.202Z","updated_at":"2025-05-07T06:43:30.029Z","avatar_url":"https://github.com/sonatype-nexus-community.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sonatype Platform on Docker\n\nThis repo contains `docker-compose` files associated sample configuration for quickly standing up a number of *Reference Architectures* for the Sonatype Platform components.\n\nIdeal if you want to get hands on quickly :-)\n\nUnless you have a license from [Sonatype](https://www.sonatype.com), you will only be able to use [Sonatype Nexus Repository OSS](https://www.sonatype.com/products/repository-oss).\n\nIf you don't have a trial license and would like one [contact Sonatype](https://www.sonatype.com).\n\n# What is the Sonatype Platform?\n\nWhen we refer to the Sonatype Platform, we actually refer to three of Sonatype's core-products and their associated add-on packs. These are:\n\n1. Sonatype Nexus Repository (either [Sonatype Nexus Repository OSS](https://www.sonatype.com/products/repository-oss) or [Sonatype Nexus Repository Pro](https://www.sonatype.com/products/repository-pro))\n2. [Sonatype Lifecycle](https://www.sonatype.com/products/open-source-security-dependency-management) and its add-on packs:\n    - [Advanced Legal Pack](https://www.sonatype.com/products/advanced-legal-pack)\n3. [Sonatype Repository Firewall](https://www.sonatype.com/products/sonatype-repository-firewall)\n4. [Sonatype SBOM Manager](https://www.sonatype.com/products/sonatype-sbom-manager)\n\nFor the full suite of products - check out [www.sonatype.com](https://www.sonatype.com).\n\n# How does this code work?\n\nWe utilise [docker-compose profiles](https://docs.docker.com/compose/profiles/) to allow you to quickly stand up the required containers to realise a specific reference architecture, customized with local `.env` configuration.\n\nAssuming you have [Docker Desktop](https://www.docker.com/products/docker-desktop) 19.03.0+ (or similar) installed, you can simply copy default `.env-example` to `.env` and run `docker-compose` passing the required profile. An example using the `proxied` profile might be:\n\n```\ncat .env-example | sed -e \"s/ORGANIZATION=sonatype/ORGANIZATION=sonatype$([ $(uname -p) = \"arm\" ] \u0026\u0026 echo \"community\")/\" -e \"s/^UID=.*$/UID=$UID/g\" -e \"s/^GID=.*$/GID=$GID/g\" \u003e .env\ndocker-compose --profile=proxied up -d\n```\n\nthen open [http://nexus-platform.localhost](http://nexus-platform.localhost)\n\n# Providing your Sonatype License\n\nFor most of the reference architectures, you'll need a Sonatype license. If you have this (it's a `.lic` file), you can use it through one of two methods:\n\n1. Put your `.lic` file in `config/sonatype-license-all.lic`\n2. Modify the path to your `.lic` file in the `.env` file:\n    ```\n    NEXUS_LICENSE_PATH=/your/path/to/your-sonatype.lic\n    ```\n\n# Reference Architecture Profiles\n\n| Profile Name    | License Required | Sonatype Platform                             | Nexus Repo                               | Sonatype Lifecycle                     | Description                                                                                           |\n| --------------- | ---------------- | --------------------------------------------- | ---------------------------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------- |\n| `proxied`       | Yes              | Yes - [here](http://nexus-platform.localhost) | Yes [here](http://repo.localhost/)       | Yes [here](http://iq.localhost/)       | Both Nexus Repository Pro and Sonatype Lifecycle available behind an NGINX reverse proxy.                |\n| `direct`        | Yes              | No                                            | Yes - [here](http://repo.localhost:8081) | Yes - [here](http://iq.localhost:8070) | Both Nexus Repository Pro and Sonatype Lifecycle available directly via `localhost` addressed over HTTP. |\n| `repoOssDemo`   | No               | No                                            | Yes - [here](http://repo.localhost:8081) | No                                     | Nexus Repo OSS will be started.                                                                       |\n| `cicd-jenkins`  | Yes              | Yes - [here](http://nexus-platform.localhost) | Yes [here](http://repo.localhost/)       | Yes [here](http://iq.localhost/)       | Includes a Jenkins [here](http://nexus-platform/jenkins)                                              |\n| `jenkins-direct` | No | No | No | No | Just Jenkins running [here](http://localhost:8888/jenkins) |\n\n## Additional Sub Profiles\n\nThe following profiles can be stood up in parallel to the `proxied` profile to provide further services:\n\n| Profile Name  | Endpoints                                                                                                                  | Description                   |\n| ------------- | -------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |\n| `swagger`     | [Swagger Editor](http://nexus-platform.localhost/swagger-editor), [Swagger UI](http://nexus-platform.localhost/swagger-ui) | Swagger Editor and Swagger UI |\n\nYou can run multiple profiles together!\n\n# License\nSee `LICENSE` file for details.\n \n\n# The Fine Print\nIt is worth noting that this is NOT SUPPORTED by Sonatype, and is a contribution of ours to 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 this project\n- DO file issues here on GitHub, so that the community can pitch in\n- Phew, that was easier than I thought. Last but not least of all:\n\nHave fun creating and using this utility to quickly get hands-on with Sonatype Nexus Repository and Sonatype Lifecycle. We are glad to have you here!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsonatype-nexus-community%2Fsonatype-platform-reference","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsonatype-nexus-community%2Fsonatype-platform-reference","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsonatype-nexus-community%2Fsonatype-platform-reference/lists"}