Skip to end of metadata
Go to start of metadata

Redirection Notice

This chapter describes how to download nopCommerce software, upload it to your server, define the file permissions, and install it on your system. You may also watch the screencast about nopCommerce installation on our YouTube channel here.

Before you begin the install, ensure that you and your web host have the minimum requirements to run nopCommerce. Then Download the required nopCommerce software to a local directory and extract the downloaded package. We provide two versions of nopCommerce a source code version and a no-source version.

Running the site using IIS (package without source code)

To use IIS, copy the contents of the extracted nopCommerce folder to an IIS virtual directory (or site root), and then view the site using a browser. If you are using IIS 7, configure it to run in integrated mode, and configure the application pool to run the .NET Framework version 4.


Running the site using Visual Studio (package with source code)

This step describes how to launch a site in Visual Studio. To run the site in Visual Studio, extract the full source code archive (.rar) to a local folder. Launch Visual Studio and select File > Open > Project/Solution. Navigate to the folder where you extracted the archive and open NopCommerce.sln solution file. Run Nop.Web project.


Getting the "ready to deploy" package (without source code) from a package with source code

If you're using nopCommerce 3.20 (or above), then follow the next steps:

  • Open the solution in Visual Studio
  • Re-build the entire solution
  • Publish the "Nop.Web" project from Visual Studio. When publishing ensure that configuration is set to "Release"

If you're using nopCommerce 2.00-3.10, then please note that publishing these versions of nopCommerce using Visual Studio is unlike publishing a regular web application. Once you’re ready to deploy the site, follow the next steps:

  • Run the Prepare.bat file to build the project in release mode and move the plugins to the correct directory.
  • Run the Deploy.bat file to perform the same procedure as the Prepare.bat file, but also move all the websites and files to the \Deployable\Nop_{Version} directory.
  • Select all the files in \Deployable\Nop_{Version} directory and upload them to your web server.
  • Note for HP (Hewlett Packard) users: HP machines come preloaded with a registry key that will interfere when running the deploy batch file. If you have an HP laptop and get the following error: "the OutputPath property is not set for project Nop.Web.csproj", then using regedit.exe navigate to HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\Environment. Delete the complete key (Key and value) Platform (your value is MCD). Restart your computer.

Installation process

nopCommerce requires write permissions for the directories and files described below:

  • \App_Data\
  • \bin\
  • \Content\
  • \Content\Images\
  • \Content\Images\Thumbs\
  • \Content\Images\Uploaded\
  • \Content\files\ExportImport\
  • \Plugins\
  • \Plugins\bin\
  • \Global.asax
  • \web.config

These permissions are validated during the installation process. If you do not have write permissions, a warning message is displayed, requesting you to configure permissions.

Before installing nopCommerce, ensure you have one of the following databases installed on your system:

  • SQL Server 2008 or higher
  • SQL Compact 4.0 or higher

If you are using SQL Server 2008 or higher, you can use any of the following authentication methods to connect to the server:

  • SQL Server Account: When connecting using this method, logins are created in the SQL Server that is not based on the Windows user accounts. Both the user name and the password are created using the SQL Server and are stored in SQL Server. When using this method you must enter your login and password.
  • Integrated Windows Authentication: When connecting using this method, the SQL Server validates the account name and password using the Windows principal token in the operating system. This means the user identity is confirmed by Windows. The SQL Server does not request a password, and does not perform the identity validation. Windows Authentication is the default authentication mode, and is much more secure than SQL Server Authentication. Windows Authentication uses Kerberos security protocol, provides password policy enforcement with regard to complexity validation for strong passwords, provides support for account lockout, and supports password expiration. A connection made using Windows Authentication is sometimes called a trusted connection, because SQL Server trusts the credentials provided by Windows.

Once you open the site for the first time, you’ll be redirected to the installation page, as follows:

  • In the Store information area, define the following:
    • In the Admin user email field, enter a new email that will be used to enter the admin area of your site.
    • In the Admin user password field, enter your new password and confirm it.
    • Check the Create sample data checkbox to include sample data in the database.
  • In the Database information area, define the following:
    • SQL Compact 4.0 or above: Select the Use built-in data storage (SQL Server Compact) checkbox.
    • SQL Standard 2008 or above: Select the Use an existing SQL Server (or SQL Express) database checkbox and define your SQL server information as follows:
      • Select the Create database if it doesn't exist option, if you want to automatically create a database if it doesn’t exist.
      • In the Database name field, enter your database name.
      • In the SQL Server name or IP address field, enter the required server name or IP address.
      • Use SQL Server account: Select this option when your SQL Server uses SQL Server Authentication. When using this option, you must enter your login and password in the relevant fields.
      • Use Integrated Windows authentication: Select this option when your SQL Server uses Integrated Windows Authentication.
  • Click Install to order to start installation process. When the setup process is complete, your new site's home page is displayed.

Note 1: The Restart installation button at the bottom of the installation page enables you to restart the installation process in case anything goes wrong.

Note 2: Ensure that your application pool is set to Integrated mode

Note 3: If you want to completely reset a nopCommerce site to its default settings, you can delete the Settings.txt file from App_Data directory. When using IIS you might want to read over the article located here.