docs@
On Windows, ProGet consists of 3 distinct deployable application components required to run the software:
These are the same as the ProGet Installation Guide.
The manual installation package is a .zip file that contains all the files and scripts necessary to create or upgrade the deployable components listed above.
To download the package, select "Manual Install" link for the desired version from the following URL: https://my.inedo.com/proget/versions. If you are unsure which version to select, use the latest version.
The manual installation package contains the following:
Note that, in earlier versions of ProGet, the directory names may be different or may be .zip files instead of directories. Regardless of the structure, the process has remained the same since ProGet v4.
By default, the ProGet installer allows configuration of its root installation directory, and will configure temporary directories and package storage paths for you. During a manual installation, these directories must be provisioned prior to installation.
Before configuring the necessary paths, you should decide where the following base directories will reside:
| Directory | Description | Installer Default |
|---|---|---|
| Root installation directory | the root disk path for the Website and Service binaries, and extensions | C:\Program Files\ProGet |
| Program data directory | the root disk path for package storage, temporary directories, and the configuration file | C:\ProgramData\ProGet |
Though not strictly required until later, you may also want to ensure the existence of the following directories if you would like to use the installer defaults:
C:\ProgramData\ProGet\ExtensionsC:\ProgramData\ProGet\ExtensionsTemp\ServiceC:\ProgramData\ProGet\ExtensionsTemp\WebC:\ProgramData\ProGet\PackagesC:\ProgramData\Inedo\SharedConfigC:\Program Files\ProGet\ExtensionsIf you plan to use other paths (i.e. UNC shares) for certain storage paths like "packages root path", you may proceed without creating the directories before they are configured in the software.
ProGet is compatible with existing supported SQL Server installations, local or remote, and also with SQL Azure. Examples here will use osql as the tool to execute sample queries (since it is installed with SQL Server), but you can also use sqlcmd or SQL Server Management Studio directly.
Server=dbserver01\SQLEXPRESS; ... vs. Server=dbserver01; ...). SQL Server Express defaults to SQLEXPRESS as the instance nameServer=localhost; ... or Server=localhost\SQLEXPRESS; ...)INEDO, and older versions (v3 and earlier) would have used the instance name PROGETProGet requires an existing SQL Server database server, so if you don't already have a database server, you'll need to create one. We recommend installing and configuring the latest version of SQL Server Express for this purpose: https://www.microsoft.com/en-us/sql-server/sql-server-editions-express
This should mostly be a guided process, but consider:
Server value in the connection stringProGet on the desired SQL Server instanceTechnically speaking, the database doesn't need to be named ProGet, but for simplicity of both upgrades and configuration, we recommend ProGet as the database name. The database collation however must be SQL_Latin1_General_CP1_CI_AS to ensure case-insensitivity in default text comparisons.
osql -E -S <db-server> -Q "CREATE DATABASE [ProGet] COLLATE SQL_Latin1_General_CP1_CI_AS"
Since most installations will use Integrated Authentication, a database server login for the ProGet user identity is required. If it doesn't exist, one can be created using this script:
osql -E -S <db-server> -Q "CREATE LOGIN [domain\ProGetServiceUser] FROM WINDOWS"
Note that built-in accounts may be used, such as NT AUTHORITY\NETWORK SERVICE or NT AUTHORITY\LOCAL SYSTEM, though an actual domain account is recommended.
For more information on creating database logins, see: https://docs.microsoft.com/en-us/sql/t-sql/statements/create-login-transact-sql
inedosql to update the databaseWhat is
inedosql?inedosql is a open-source command-line tool developed by Inedo in order to execute SQL (.sql) scripts against a SQL Server database. Scripts with
AH:ScriptIdheaders specify a globally unique GUID to a specific script that is added to an implementation-defined metadata table (typically named similar to__InedoDb_DbSchemaChanges) when the script is run so it only gets run once no matter how many times theupdatecommand is run. SQL scripts without this header are executed every time the command is run. All scripts are run in the order they are defined on disk, i.e. lexicographically. See the inedosql GitHub page for more information.
Copy the SqlScripts directory into a temporary directory.
Run command line and change current directory to the SqlScripts folder which contains inedosql.exe file.
Run the following command in that directory, replacing the connection string as needed:
.\inedosql.exe update . --connection-string=<connection-string>
For example:
cd C:\ProGetSetup5..14_Manual\
.\inedosql.exe update . --connection-string="Server=dbserver01\SQLEXPRESS; Database=ProGet; Integrated Security=true;"
This command will both update the schema of the target database, and recreate all objects (views, functions, stored procedures).
On new installations, be sure to note the connection string that was used for this command, as it be a required value in the configuration file that instructs ProGet which database to connect to.
In ProGet 5.2 and earlier, dbupdater.exe is used to update the database. Use these instructions for updating the database:
Copy the SqlScripts directory into a temporary directory.
Run command line and change current directory to the SqlScripts folder which contains dbupdater.exe file.
Unpack required scripts from Scripts.gz with the following command:
.\dbupdater.exe unpack .\Scripts.gz .
.\dbupdater.exe update . <connection-string>
For example:
cd C:\ProGetSetup5.2.14_Manual\
.\dbupdater.exe unpack .\Scripts.gz .
.\dbupdater.exe update . "Server=dbserver01\SQLEXPRESS; Database=ProGet; Integrated Security=true;"
ProGet database roleIn order for the database server login to access the database with the permissions required by ProGet, a database user must be created:
osql -E -S <db-server> -d ProGet -Q "CREATE USER [domain\ProGetServiceUser] FOR LOGIN [domain\ProGetServiceUser]"
Then the user must be granted access to the ProGet user role (which was added during the "run dbupdater.exe" step):
osql -E -S <db-server> -d ProGet -Q "ALTER ROLE [ProGetUser_Role] ADD MEMBER [domain\ProGetServiceUser]"
Before installing ProGet in IIS, the following roles/features must be enabled in Windows:
Copy the contents of Web directory from the installation package to a subdirectory of the root installation directory identified earlier. For reference, the installer defaults this to: C:\Program Files\ProGet\Web
While you could use an existing application pool if desired, we recommend creating a new one. The minimum requirements for the application pool are:
Example PowerShell command to create an app pool:
&"C:\Windows\System32\inetsrv\appcmd.exe" add apppool /name:ProGet /managedRuntimeVersion:v4.0 /managedPipelineMode:Integrated /processModel.identityType:SpecificUser /processModel.userName:ProGetServiceUser@domain /processModel.password:<account-password>
You may adjust other application pool settings as desired.
The minimum requirements for the IIS web site are:
Note that any of these values can be edited once they are created, for example, to add SSL certificates, update the port that ProGet is listening on, etc.
Example PowerShell command to create a site:
&"C:\Windows\System32\inetsrv\appcmd.exe" add site /name:ProGet /physicalPath:"C:\Program Files\ProGet\Web" /bindings:"http/*:80:" /applicationDefaults.applicationPool:ProGet
You may adjust other IIS site settings as desired.
Copy the contents of Service directory from the installation package to a subdirectory of the root installation directory identified earlier. For reference, the installer defaults this to: C:\Program Files\ProGet\Service
The copied service files will contain the service executable ProGet.Service.exe; run this program from an elevated command prompt or PowerShell window to install the Windows Service (INEDOPROGETSVC):
PS C:\Program Files\ProGet\Service> .\ProGet.Service.exe install --user="ProGetServiceUser@domain" --password="<account-password>"
Note: at this time, it is not permitted to change the service name from INEDOPROGETSVC.
The service can be started from the Windows Service Controller, or using the following PowerShell command:
Start-Service INEDOPROGETSVC
Once the Website and Service are started, ProGet should be accessible via the binding specified in IIS site step 3. The first time you access ProGet via the Website, some additional settings must be configured.
Once the Website, Service, and Database are configured, the final step is to create or update the ProGet Configuration File to supply the database connection string noted earlier in step 3 of the database configuration, and ensure WebServer Enabled="false".
Once values in this file are changed, any IIS application pool or ProGet Windows Service that reference it must be restarted to see the new values.
Once you log-in to ProGet for the first time, you can visit the Administration > Advanced Settings page to finalize the configuration stored in the database.
The following settings within the product that must be configured, their corresponding directories, and their installer defaults are listed below:
| Setting | Description | Installer Default |
|---|---|---|
Extensions.BuiltInExtensionsPath | path containing extensions included with the installation package | C:\Program Files\ProGet\Extensions |
Extensions.ExtensionsPath | the disk path where downloaded extensions are stored and loaded from by ProGet | C:\ProgramData\ProGet\Extensions |
Extensions.UseNewExtensionLoader | when set, uses CommonCachePath instead of ServiceTempPath and WebTempPath for Extensions | true (checked) |
Extensions.CommonCachePath | used only when UseNewExtensionLoader is true, a temp path where extensions loaded from ExtensionsPath are extracted to and loaded by the ProGet service | C:\ProgramData\ProGet\ExtensionsCache |
Extensions.ServiceTempPath | used only when UseNewExtensionLoader is false, a temp path where extensions loaded from the extensions path are extracted to and loaded by the ProGet service | C:\ProgramData\ProGet\ExtensionsTemp\Service |
Extensions.WebTempPath | used only when UseNewExtensionLoader is false, a temp path where extensions loaded from the extensions path are extracted to and loaded by the ProGet Website | C:\ProgramData\ProGet\ExtensionsTemp\Web |
Extensions.UpdateFeedUrl | the extensions feed URL, required to browse extensions in the software | https://proget.inedo.com/upack/Extensions |
Storage.PackagesRootPath | base path on disk for ProGet's default package store | C:\ProgramData\ProGet\Packages (more info) |
The directories referenced in the configuration values must exist prior to beginning use of ProGet as a package manager - ProGet does not create them for you. If they do not exist, several extensions-related errors will be logged in the Diagnostic Center, and/or packages may be stored on disk in an undefined manner. If the directories did not exist but ProGet was already started, both the IIS application pool and Windows Service must be restarted.
Each of these directories can assigned to a path on a local volume or UNC share provided that:
We do not recommend using a mapped drive (e.g. X:\Packages) to reference directories for the reasons described here: https://docs.microsoft.com/en-us/windows/win32/services/services-and-redirected-drives. Instead, use the full UNC path that the drive is mapped to, for example: \\file-sv01\$x\packages
If you do attempt to use a mapped drive (or you are installing on Azure using Azure Files as the backing store), you may need to configure the ProGet application pool to set the Load User Profile property to True.
The Storage.PackagesRootPath setting defines the base storage location on disk for packages managed by ProGet's default package store. Its value is stored in the database and assignable on the Advanced Settings page.
There are several other packages path settings (e.g. Storage.NpmPackagesLibrary, Storage.MavenArtifactLibrary) that by default are relative to the Storage.PackagesRootPath. If one of these settings is individually set, it will override the default behavior of being relative to the root path. To restore that behavior, save the desired field with an empty value.
Note: Older load-balanced installations may have stored the ProGetConfig.Storage.PackagesRootPath storage location in a web application configuration file. This source of configuration will be removed in a future version of ProGet, replaced solely by the database setting. If you see the ProGetConfig.Storage.PackagesRootPath setting in an existing Web_appSettings.config, its value should be migrated to the Storage.PackagesRootPath setting in Administration > Advanced Settings. The database setting already takes precedence if it exists, so if there is an existing value for this setting on the Advanced Settings page, it can be removed from the configuration file.
All editions of ProGet require a valid license to use. Once the ProGet Website is accessible, you must visit the Administration > Licensing & Activation page to apply a license key. If ProGet is able to access the internet, the key will be automatically activated.
If you have already obtained a license key but cannot automatically activate, visit the License Key Activation documentation for more information on manual activation.
If you do not have a license key yet (or do not know what yours is), you may view keys associated with your organization or request one from MyInedo.
While extensions are available in our own public ProGet instance, the ProGet installation ships with "frozen" or "locked" versions of the extensions at the time the installer was built.
Once the Extensions.BuiltInExtensionsPath setting is configured to a valid directory, copy the contents of Extensions/ directory from the installation package into that directory, then restart the application pool and ProGet Windows Service. Any extensions in this path are combined with the extensions managed within the ProGet software (i.e. downloaded from the Administration > Extensions page and stored in the Extensions.ExtensionsPath directory), and the "latest" SDK-compatible version (as per semantic versioning rules) is loaded.
For installations that are restricted from accessing the internet, or if you with to install a version other than the latest, extensions can also be installed manually:
Extensions.ExtensionsPath setting.<extension-name>.upack in the extensions directory, and that no other files with the same name exist in that directory, even with a different extension. For example, make sure to delete an existing <extension-name>.inedox file if you are installing <extension-name>.upack. The downloaded file may contain a version part, which should be removed (e.g. InedoCore-1.5.0.upack should be just InedoCore.upack)Note: the InedoCore extension must be installed to use Active Directory integration.
Upgrading a ProGet installation from an existing installation can be performed by following this installation guide, except it should be much simpler and quicker than the initial installation since the infrastructure is already in place.
This guide may also be used to upgrade an instance that was installed by the installer, but once that has occurred, this manual process must be used going forward.
To backup the instance, refer to the Backup and Restoring ProGet documentation.
Before upgrading ProGet, the existing instance must be taken offline. Ensure that the application pool and Windows Service are both stopped.
Here is an example PowerShell script that performs these operations:
&"C:\Windows\System32\inetsrv\appcmd.exe" stop apppool ProGet
Stop-Service INEDOPROGETSVC
For the most part, an upgrade is an "XCOPY deployment" of files from the manual installation package. Copy all of the contents of each of the following into the specified target directory while carefully analyzing the differences in configuration files as noted:
| Contents | Target | Installer Default | Notes |
|---|---|---|---|
| Service | Service installation directory | C:\Program Files\ProGet\Service | May overwrite existing App_appSettings.config if empty |
| Web | Website application home directory | C:\Program Files\ProGet\Web | May overwrite existing Web_appSettings.config if empty |
| Extensions | Extensions.BuiltInExtensionPath directory | C:\Program Files\ProGet\Extensions | Overwrite contents with install package contents |
While v5.1.0 and later versions of ProGet should not store data in these configuration files, existing installations might contain relevant data such as connection strings that should ultimately be migrated to the ProGet Configuration File and removed from the *_appSettings.config file.
Because the tool used to update the database schema is aware of previous scripts that have run, this process is the same as the initial installation process. See Running dbupdater.exe above to perform this step using the existing connection string specified in the ProGet Configuration File. An additional benefit of being aware of previous scripts that have run is that the dbupdater.exe command can be applied to a database copy or backup to test the SQL upgrade before running it against a production database.
Once all files are copied and the database is updated, the services can be started to bring ProGet back online.
Here is an example PowerShell script that performs these operations:
&"C:\Windows\System32\inetsrv\appcmd.exe" start apppool ProGet
Start-Service INEDOPROGETSVC
There are a lot of moving pieces involved in a manual installation (particularly ones that the installer would have handled for you). Here are the most common manual installation errors as we have noted from our various support channels.
Perhaps the most common problem is that the SQL Server database is inaccessible. Check the following:
ProGetUser_RoleNETWORK SERVICE and connect to a remote database)SQLEXPRESS)Typically when the ProGet Windows Service does not start, it is database connection-related. Any errors logged by the ProGet Service can be found in the Windows Event Log under Windows Logs > Application.
Alternatively, you can run the service interactively (i.e. in a command window) to view live log output. Simply ensure the INEDOPROGETSVC service is stopped, then run the following command as an administrator:
PS C:\Program Files\ProGet\Service> .\ProGet.Service.exe run --mode=serviceonly
If there is a difference in behavior when run interactively vs. running the service, there may be a problem with the user account that the ProGet service is running as.
Visit the Service Messenger documentation for enabling inter-process communication between the ProGet Website and ProGet Service.
Extensions failing to load is commonly caused by:
Load errors for extensions are logged in the Diagnostic Center.
Inedo offers several support mechanisms if you have any other questions regarding a manual installation:
Is this documentation incorrect or incomplete? Help us by contributing!
This documentation is licensed under CC-BY-SA-4.0 and stored in GitHub.