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.
Before you begin the installation, ensure that your web host meets the minimum requirements to run nopCommerce.
For more information on hosting selection guidelines, visit this page.
There are several options available when downloading nopCommerce. In order to determine which option to download, you need to decide how you will use it. The following options are available:
- Web (no source). This option is available for users who do not wish/need to develop any custom code. This is a precompiled version of nopCommerce that can simply be uploaded to your hosting provider and used immediately. With this option, users can still modify the look and feel or user interface (UI) of their site to suit their needs, but they do not have to worry about the development.
- Source code. This option contains a full Visual Studio solution. It is for those users who wish to customize the code within nopCommerce. It contains all the source code used to develop nopCommerce and must be opened in Visual Studio. It also includes scripts to build and compile the solution to upload to your hosting provider.
- Upgrade script. The upgrade script option is for users who have a nopCommerce installation already in place. The script will upgrade your current installation to the latest version.
With each of these options, excluding the upgrade script, you can deploy nopCommerce to your development environment and your hosting provider. Choose the option you would like to download and click the appropriate download link to start your download. It is recommended to create a new folder on your desktop to store your downloaded files for easy access.
Running the site using IIS (package without the 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 nopCommerce 3.90 or below, then configure it to run in integrated mode, and configure the application pool to run the .NET Framework version 4. Please note that it's not required for nopCommerce 4.00 and above.
Running the site using Visual Studio (package with the 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 to a local folder. Launch Visual Studio and select File → Open → Project/Solution. Navigate to the folder where you extracted the archive and open the
NopCommerce.sln solution file. Run
Getting the "ready to deploy" package (without the source code) from a package with the source code
If you're using nopCommerce 3.20 (or above), then please follow these steps:
- Open the solution in Visual Studio.
- Rebuild the entire solution.
- Publish the Nop.Web project from Visual Studio. When publishing, ensure that configuration is set to Release.
nopCommerce requires written permissions for the directories and files described below:
For nopCommerce versions 4.00 and above:
\App_Data\appsettings.json(or dataSettings.json for earlier versions; after installation)
For nopCommerce versions 2.00-3.90:
These permissions are validated during the installation process. If you have no written permissions, a warning message will be displayed, requesting you to configure permissions. Before installing nopCommerce, ensure you have a database server installed on your system.
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 stored in the 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 requests no 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 the SQL server trusts the credentials provided by Windows.
Once you open the site for the first time, you will be redirected to the installation page as follows:
In the Store information panel, fill the following details:
- Admin user email: this is the email address of the first admin of the site.
- Admin user password: you will need to supply a password for the admin account.
- Confirm the password: confirm the admin user password.
- Country: select the country from the dropdown list. It allows preconfiguring your store based on the country you selected. For example:
- download and preinstall a language pack from the official site
- preconfigure some settings (for example, PangV or "Display tax/shipping info" settings for Germany)
- preconfigure some shipping details, VAT settings, currencies, measures, and more.
- Create sample data: select this checkbox if you would like sample products to be created. This is recommended so you can start working with your site before adding any of your own products. You can always delete these items later, or unpublish them so that they no longer appear on your site.
In the Database information panel, you need to enter the following info:
- Database: here you can select either Microsoft SQL Server, MySQL, or PostgreSQL.
- Create database if it doesn't exist: it is recommended that you create your database and database user beforehand to ensure a successful installation. Simply create a database instance and add the database user to it. The installation process will create all the tables, stored procedures, and more.
- Enter raw connection string (advanced): select this checkbox if you want to enter a Connection string instead of filling the connection fields.
- Server name: this is the IP, URL, or server name of your database. Get your server name from the database management system or from the hosting control panel.
- Database name: this is the name of the database used by nopCommerce. If you opted to create your database ahead of time, use the name you gave your database here.
- Use integrated Windows authentication: if you are installing at a hosting provider, you can use your SQL Server account and supply the credentials you created with your database. In this case don't select this option. If you are using a development environment, you can select Windows authentication. In this case, select this checkbox. If you are using Windows authentication, the account hosting the application pool in IIS must be a user in the database.
- SQL Username: enter your database user login.
- SQL Password: enter your database user password.
- Specify custom collation: this is an advanced setting and should be left clear.
Click Install to start the installation process. When the setup process is complete, your new site's home page will be displayed.
The Restart installation button at the bottom of the installation page enables you to restart the installation process in case anything goes wrong.
If you are using nopCommerce 3.90 or below, ensure that your application pool is set to the Integrated mode.
If you want to completely reset a nopCommerce site to its default settings, you can delete the ConnectionStrings section from the
dataSettings.json for earlier versions) file located in the
App_Data directory. You can even delete this whole file but note that in this case, it will be recovered on the next run with default values, so you can lose your settings.