Downloads:

767

Downloads of v 1.0.1:

213

Last Update:

15 Jun 2020

Package Maintainer(s):

Software Author(s):

  • Paul Broadwith

Tags:

nexus repository

Nexus - Create Chocolatey Repository

1.0.1 | Updated: 15 Jun 2020

Downloads:

767

Downloads of v 1.0.1:

213

Software Author(s):

  • Paul Broadwith

Nexus - Create Chocolatey Repository 1.0.1

This Package Contains an Exempted Check

1 Test Passing and 1 Exempted Test


Validation Testing Passed


Verification Testing Exempt:

Package has required parameters, and therefore can't be tested on package-verifier.

To install Nexus - Create Chocolatey Repository, run the following command from the command line or from PowerShell:

>

To upgrade Nexus - Create Chocolatey Repository, run the following command from the command line or from PowerShell:

>

To uninstall Nexus - Create Chocolatey Repository, run the following command from the command line or from PowerShell:

>

NOTE: This applies to both open source and commercial editions of Chocolatey.

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

  • Open Source or Commercial:
    • Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://chocolatey.org/api/v2. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
    • You can also just download the package and push it to a repository Download

3. Enter your internal repository url

(this should look similar to https://chocolatey.org/api/v2)

4. Choose your deployment method:


choco upgrade chocolatey-nexus-repo -y --source="'STEP 3 URL'" [other options]

See options you can pass to upgrade.

See best practices for scripting.

Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.

If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:


choco upgrade chocolatey-nexus-repo -y --source="'STEP 3 URL'"
$exitCode = $LASTEXITCODE

Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
  Exit 0
}

Exit $exitCode

- name: Ensure chocolatey-nexus-repo installed
  win_chocolatey:
    name: chocolatey-nexus-repo
    state: present
    version: 1.0.1
    source: STEP 3 URL

See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.

Coming early 2020! Central Managment Reporting available now! More information...


chocolatey_package 'chocolatey-nexus-repo' do
  action    :install
  version  '1.0.1'
  source   'STEP 3 URL'
end

See docs at https://docs.chef.io/resource_chocolatey_package.html.


Chocolatey::Ensure-Package
(
    Name: chocolatey-nexus-repo,
    Version: 1.0.1,
    Source: STEP 3 URL
);

Requires Otter Chocolatey Extension. See docs at https://inedo.com/den/otter/chocolatey.


cChocoPackageInstaller chocolatey-nexus-repo
{
   Name     = 'chocolatey-nexus-repo'
   Ensure   = 'Present'
   Version  = '1.0.1'
   Source   = 'STEP 3 URL'
}

Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.


package { 'chocolatey-nexus-repo':
  provider => 'chocolatey',
  ensure   => '1.0.1',
  source   => 'STEP 3 URL',
}

Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.


salt '*' chocolatey.install chocolatey-nexus-repo version="1.0.1" source="STEP 3 URL"

See docs at https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.chocolatey.html.

5. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

This package was approved by moderator mwallner on 11 Jul 2020.

Description

Creates a NuGet repository under Nexus for use with Chocolatey.

You can pass the following parameters (to not log sensitive parameters, replace --params with --package-parameters-sensitive below):

  • /ServerUri - The Uri of your Nexus server. Defaults to https://localhost:8081 (e.g. --params="'/ServerUri=http://localhost:8081'");
  • /Username - [Required] Username with permissions to create repositories and add the NuGet Realm on your Nexus server (e.g. --params="'/Username=admin'");
  • /Password - [Required or use /EnterPassword] Password for the username parameter (e.g. --params="'/Username=admin /Password=abc'");
  • /RepositoryName - The name to use for the created repository. Defaults to choco-base (e.g. --params="'/RepositoryName=my-repo'");
  • /BlobStoreName - Name of the blob store to create the repository on. Defaults to default. (e.g. --params="'/BlobStoreName=myblob'");
  • /EnterPassword - [Required or use /Password] Prompts you to enter a password when installing the package (e.g. --params"'/EnterPassword'") ;

NOTE: Uninstalling this package does not remove the repository created or disable the NuGet Realm in Nexus. This must be done manually.


tools\chocolateyInstall.ps1
$ErrorActionPreference = 'Stop'

# default parameters
$defaultParams = @{
    ServerUri      = 'http://localhost:8081'
    RepositoryName = 'choco-base'
    BlobStoreName  = 'default'
}

function Invoke-NexusScript {
    [CmdletBinding()]
    Param (
        [Parameter(Mandatory)]
        [String]
        $ServerUri,

        [Parameter(Mandatory)]
        [Hashtable]
        $ApiHeader,

        [Parameter(Mandatory)]
        [String]
        $Script
    )

    $scriptName = [GUID]::NewGuid().ToString()
    $body = @{
        name    = $scriptName
        type    = 'groovy'
        content = $Script
    }

    # Call the API
    $baseUri = "$ServerUri/service/rest/v1/script"

    #Store the Script
    $uri = $baseUri
    Invoke-RestMethod -Uri $uri -ContentType 'application/json' -Body $($body | ConvertTo-Json) -Header $ApiHeader -Method Post
    #Run the script
    $uri = "{0}/{1}/run" -f $baseUri, $scriptName
    $result = Invoke-RestMethod -Uri $uri -ContentType 'text/plain' -Header $ApiHeader -Method Post
    #Delete the Script
    $uri = "{0}/{1}" -f $baseUri, $scriptName
    Invoke-RestMethod -Uri $uri -Header $ApiHeader -Method Delete

    $result
}

# defaults
$params = Get-PackageParameters

# Check for mandatory parameters
if (-not ($params.Username)) {
    Write-Error "Mandatory parameter 'Username' missing." -ErrorAction Continue
    $missingParams = $true
}

if (-not ($params.Password -or $params.EnterPassword)) {
    Write-Error "Mandatory parameter 'Password' OR 'EnterPassword' missing." -ErrorAction Continue
    $missingParams = $true
}

if ($missingParams) {
    Write-Error "Please re-run the package install providing the missing parameters."
}

# Prompt for the password if the /EnterPassword parameter has been added
if ($params.EnterPassword) {
    # Use -AsSecureString so the characters are not echoed to the screen. 
    # But it does mean we need to extrac tht plain test password later.
    $securePassword = Read-Host -Prompt "Enter the password for user '$($params.Username)'." -AsSecureString

    # Now unencrypt the password
    $bstr = [System.Runtime.InteropServices.Marshal]::SecureStringToBSTR($securePassword)
    $params.Password = [System.Runtime.InteropServices.Marshal]::PtrToStringAuto($bstr) 

    # Remove the EnterPassword parameter as it shows up later when we list the parameter values we are going to use.
    # I feel like it will cause confusion.
    $params.Remove('EnterPassword')
}

# loop through the defaults
# if a parameter does not exist that matches the $defaultParams.Keys then use the value from $defaultParams
$defaultParams.Keys | ForEach-Object {
    if (-not $params.$_) {
        $params.$_ = $defaultParams.$_
    }
}

# trim any trailing '/' from the URI
$params.ServerUri = $params.ServerUri.trim('/')

# Tell the user the details we are going to use
Write-Host "Will create a repository using these details:"
$params.Keys | ForEach-Object {
    if ($_ -eq 'password' -or $_ -eq 'enterpassword') {
        $msg = '******'
    }
    else {
        $msg = $params.$_
    }

    Write-Host ("    {0,-20} : {1}" -f $_, $msg)
}

# Create the Api header
$credPair = ("{0}:{1}" -f $params.Username, $params.Password)
$encodedCreds = [System.Convert]::ToBase64String([System.Text.Encoding]::ASCII.GetBytes($credPair))
$header = @{
    Authorization = "Basic $encodedCreds"
}

# Check the repo does not already exist
$repositories = Invoke-RestMethod -Uri 'http://localhost:8081/service/rest/v1/repositories' -Method Get -Headers $header
if ($params.RepositoryName -in @($repositories.Name)) {
    throw "Cannot create repository '$($params.RepositoryName)' as it already exists!"
}

# Create the NuGet Repo
$createRepoParams = @{
    ServerUri = $params.ServerUri
    ApiHeader = $header
    Script    = @"
import org.sonatype.nexus.repository.Repository;
repository.createNugetHosted("$($params.RepositoryName)","$($params.BlobStoreName)");
"@
}

Invoke-NexusScript @createRepoParams | Out-Null

# Enable the NuGet Relam
$enableNugetRealmParams = @{
    ServerUri = $params.ServerUri
    ApiHeader = $header
    Script    = @"
import org.sonatype.nexus.security.realm.RealmManager

realmManager = container.lookup(RealmManager.class.getName())

// enable/disable the NuGet API-Key Realm
realmManager.enableRealm("NuGetApiKey")
"@
}

Invoke-NexusScript @enableNugetRealmParams | Out-Null

Log in or click on link to see number of positives.

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Version Downloads Last Updated Status
Nexus - Create Chocolatey Repository 1.0.0 554 Thursday, September 19, 2019 Approved

This package has no dependencies.

Discussion for the Nexus - Create Chocolatey Repository Package

Ground Rules:

  • This discussion is only about Nexus - Create Chocolatey Repository and the Nexus - Create Chocolatey Repository package. If you have feedback for Chocolatey, please contact the Google Group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or Nexus - Create Chocolatey Repository, or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.
comments powered by Disqus