Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
100 lines (96 sloc) 5.45 KB
<html>
<head>
<title>Universal Package Explorer</title>
<meta name="subtitle" content="Universal Package Explorer" />
<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
<meta name="keywords" content="proget, romp, upack" />
<meta name="show-headings-in-nav" content="true" />
<meta name="sequence" content="50" />
</head>
<body>
<p>
The Universal Package Explorer is a Windows desktop application that makes it easy to create, view, and publish universal packages.
You can load a .upack file from disk, or directly from a ProGet universal feed.
</p>
<h3 id="installation">Download, Installation, &amp; Source Code</h3>
<p>
Visit the <a href="https://github.com/Inedo/UniversalPackageExplorer/releases" target="_blank">GitHub Releases</a>
section to download the latest installer.
</p>
<p>
The source code for Universal Package Explorer is hosted on <a href="https://github.com/Inedo/UniversalPackageExplorer" target="_blank">GitHub</a>.
</p>
<h2 id="creating-publishing" data-title="Creating and Publishing a Universal Package">Creating and Publishing a Universal Package</h2>
<h4>
<i>Prerequisites:</i>
</h4>
<ul class="docs">
<li>
Download and install the latest Universal Package Explorer from any of the locations here: <a href="https://inedo.com/upack/download" target="_blank">https://inedo.com/upack/download</a>
</li>
<li>
Download Accounts.zip from: <a href="http://cdn.inedo.com/downloads/upack/Accounts.zip">http://cdn.inedo.com/downloads/upack/Accounts.zip</a>
</li>
<li>
An installed instance of ProGet with a Universal Feed configured
</li>
</ul>
<h3 id="overview">Overview</h3>
<p>
In this tutorial, we will take an existing website and package it into a Universal Package using the Universal Package Explorer. The files in Accounts.zip are just the build output of a basic .NET web application. For those unfamiliar with .NET, it could just as easily be a Java WAR file, a collection of PHP files, or even static HTML.
</p>
<iframe width="690" height="388" src="https://www.youtube.com/embed/fe25YLZbCaA" frameborder="0" allowfullscreen="true"></iframe>
<p>
If you want to go through the full step-by-step tutorial, and create and publish a universal package yourself, follow the instructions below.
</p>
<h3 id="creating" data-title="Creating a Package">Creating a Package</h3>
<p>
In this step, we will create a Universal Package. To begin, we will download the Accounts.zip file and extract its contents into a temporary directory (in this example, we will use <code>C:\tmp\accounts</code>).
</p>
<p>
Open the Universal Package Explorer and select "Create a new package" option:
</p>
<img class="screenshot" src="/resources/documentation/upack/upe/create-new-package.png" alt="Create New Package" />
<p>
From here, we can add the files in <code>C:\tmp\accounts</code> into the package via the <i>Contents</i> > <i>Add</i> > <i>Existing Folder</i> option:
</p>
<img class="screenshot" src="/resources/documentation/upack/upe/add-files.png" alt="Add Files" />
<p>
Once the files are added to the package, we can modify the metadata. Click the "Edit" button, and enter the following values:
</p>
<ul class="docs">
<li>
<strong>Name:</strong> Accounts
</li>
<li>
<strong>Version:</strong> 1.0.0
</li>
<li>
<strong>Title:</strong> Accounts Website
</li>
<li>
<strong>Description:</strong> This package contains the build output for the Accounts demo website
</li>
</ul>
<p>
Switching back to View mode will now display the metadata:
</p>
<img class="screenshot" style="border: 1px solid #808080;" src="/resources/documentation/upack/upe/display-metadata.png" alt="Display Metadata" />
<p>
Now the package is complete. Select <i>File</i> > <i>Save</i> to save the package to disk as a .upack file.
</p>
<h3 id="pushing" data-title="Pushing a Package to a Universal Feed">Pushing a Package to a Universal Feed in ProGet</h3>
<p>
Once a package is created, we are now able to publish it to a Universal feed. Before we can push the package, we must determine the endpoint of the ProGet feed to use it as the push source. After logging into ProGet and browsing to the feed, take note of the endpoint URL:
</p>
<img class="screenshot" style="border: 1px solid #808080;" src="/resources/documentation/upack/upe/api-endpoint-url.png" alt="API Endpoint URL" />
<p>
Using this value, we can now push our newly generated package to the feed. From the Universal Package Explorer main menu, select <i>File</i> > <i>Publish…</i> to open the Publish window:
</p>
<img class="screenshot" style="border: 1px solid #808080;" src="/resources/documentation/upack/upe/publish-window.png" alt="Publish Window" />
<p>
Enter the feed endpoint URL and credentials configured to push packages, then click "Log in", and if the credentials are valid, click "Publish". Once successful, browsing to the feed within ProGet will display the package:
</p>
<img class="screenshot" style="border: 1px solid #808080;" src="/resources/documentation/upack/upe/display-package-pg.png" alt="Display Package in ProGet" />
</body>
</html>