Skip to main content

Build your local powershell module repository - ProGet

So Windows Powershell Blog released a blog a couple of days ago (link). Not too long after, a discussion emerged about it being to complicated to setup. Even though the required software is open source (nugetgalleryserver), it looks like you need to have Visual Studio Installed to compile it. I looked into doing it without visual stuidio, however I have been unable to come up with a solution. I even tweeted about it since I am not an developer. Maybe someone how is familiar with “msbuild” could do a post on how to do it without VS.

Anyhow one of my twitter-friends (@sstranger) came to the rescue and pointed me in the direction of ProGet, hence the title of this post. ProGet comes in 2 different licensing modes
  • Free (reduced functionality)
  • Enterprise (paid version with extra features)
The good news is that the free version supports hosting a local PowershellGet repository which was my intention anyway. So off we go and create a Configration that can install ProGet for us. This is the configuration I will use:

image

Please note we have to provide a ProductId parameter to the Package resource. Also you may tune the Arguments parameter with the options available. The documentation for silently installing ProGet is here. Basically I am installing the easy way with SQL Express and the integrated web server. The installer supports full SQL and IIS if you require that. Notice also that the path parameter is an URL pointing to the installer. A hidden feature of the Package resource in DSC.

Playing around with the installer, I used these arguments when I installed the application:

Arguments = "/S /Edition=LicenseKey /LicenseKey=R80GE44F-CFQK-NH7A38-VR4MSP-KU8Q6K9Y /Port=80 /InstallSqlExpress"

Apparently their documentation is not updated since they claim that the parameter is called Licensekeys (plural), however just drop the s and use Licensekey and you will be alright. Just incase you are wondering, that is not my licensekey :-)

So dot-source the configuration or press the green play button i ISE, run the configuration to create the MOF-file and do a Start-DSCconfiguration. If you have no idea what I am talking about, head over to powershell.org and get their free E-book on Powershell DSC. Or if you prefer just download the software and run through the installer like we did in 2003 :-)

Here is my output:

image

So let’s start your favorite web browser and navigate to http://localhost or use the name of your server:

image

You will notice that there is a default repository that links to Nuget. We don not care and will create our new PowershellGet repository.

image

We will create a feed called MSpowershell, really original. Things to notice is the API key field. Just leave it blank for now. Let’s publish a module to the repository:

image

Notice the NuGetApiKey value. It is set to the default combination of the admin user in ProGet (user:pass). If your repository have a blank API key like the one we created, that works fine. If you configure the feed with an API key, you will need to look into permissions/privileges. I have not played with it much yet, however maybe I will write another post lagter. So back to our browser, can we see a module published?

image 
And there it is. There is one final piece of the puzzle. You have to change the URL for the gallery settings in the PowershellGet module (PSGalleryPublishUri and PSGallerySourceUri). This is what I used:

image

If you ask me, it does not get any easier than this. Happy scripting and start to create your local powershell repository.

Cheers

Tore

Comments

  1. Hi, and thanks for writing a very useful and clarifying post. I have been looking for something exactly like this.
    It seems like a very simple and nice way to publish scripts for re-use. I am also interested in version control and the deploying of scripts/modules to many servers at once. It seems that maybe Inedo's other product, Buildmaster might be the answer. Any input is greatly appreciated!

    Best regards, Magnus

    ReplyDelete
    Replies
    1. It has been over a year ago since I wrote this. Things have changed a bit to say the least. Have you looked at the powershellget module? Currently it works with the powershellgallery.com website (publicly available), however you just need to update the nuget urls to use the module against for instance ProGet or a Nuget gallery.

      I have not looked at Buildmaster yet. It is on my loooong todo list.

      Cheers

      Tore
      (sorry for the late reply, been super buzy as always)

      Delete
    2. Thanks for the reply, and sorry for the double commenting on this article, didn't realize both was in queue for your approval. I will definitely check out powershellget.

      Delete
  2. This comment has been removed by the author.

    ReplyDelete
    Replies
    1. Thank you, always a pleasure to hear!

      /Tore

      Delete

Post a Comment

Popular posts from this blog

Developing PowerShell modules for REST APIs – Part1

Over the years I have developed different PowerShell modules for different web APIs. I thought it would be a good idea to write a 2 series post about how you could go about to do this. This will be a 2 part blog series where we will run through the entire process of building a module for a REST API. I will try my best to keep this as simple as possible and leave more advanced stuff for a follow up post if the interest is there.What you needDepending on your experience with source control and PowerShell in general, you might want to use GIT or some other software repro for the code. In addition we are going to create a test REST API using the splendid UniversalDashboard PowerShell module created by Adam Driscoll. It is available on the PowershellGallery. Other prerequisites are built-in to Powershell. I will assume that you will be following along using at least PowerShell version 5 or greater.
What is HTTP metods for REST API.The primary or most common HTTP verbs used are POST, GET, PU…

Serialize data with PowerShell

Currently I am working on a big new module. In this module, I need to persist data to disk and reprocess them at some point even if the module/PowerShell session was closed. I needed to serialize objects and save them to disk. It needed to be very efficient to be able to support a high volume of objects. Hence I decided to turn this serializer into a module called HashData.



Other Serializing methods

In PowerShell we have several possibilities to serialize objects. There are two cmdlets you can use which are built in:
Export-CliXmlConvertTo-JSON
Both are excellent options if you do not care about the size of the file. In my case I needed something lean and mean in terms of the size on disk for the serialized object. Lets do some tests to compare the different types:


(Hashdata.Object.ps1)

You might be curious why I do not use the Export-CliXML cmdlet and just use the [System.Management.Automation.PSSerializer]::Serialize static method. The static method will generate the same xml, however we …

Developing PowerShell modules for REST APIs – Part2

This is part 2 of the REST API blogpost. In part1 we successfully setup two REST API endpoints using the UniversalDashboard PowerShell module. In this part we are going to create a simple module that support some CRUD operation against our API. As we are trying to keep things as simple as possible, we will not use any fancy framework (like Plaster) to build our module. We are also going to skip a very important step you should familiarize yourself with, Pester tests. Lets get to it.


The moduleWe will build a module called FilesAPI. The module folder will look like this:



In the functions folder I have already added the 2 helper functions from part 1, Get-AuthorizationHeader and ConvertTo-Base64. The other folders are just placeholders for important stuff like classes, private functions that you do not want to make available for the module consumer and tests for Pester tests. For such a small module that we are going to create, one could argue that it is much easier to just add the functi…