Install Neptune DXP - Open Edition on Windows with the Neptune DXP Installer – Open Edition (Windows)

The Neptune DXP Installer – Open Edition (Windows) provides a method to install Neptune DXP - Open Edition on Windows systems. During installation, you can select options and configure settings, such as database connections, to prepare the application for use on your system. You can perform a so-called quick installation or advanced installation depending on your specific use case.

Data loss

By default, all data is stored locally using SQLite.

If you delete the installation folder, your data will be lost and cannot be recovered.

We recommend the following:

  • Use SQLite only for temporary testing or evaluations.

  • Back up the SQLite folder regularly.

  • Use a dedicated database, for example, PostgreSQL, or MySQL, for anything beyond short-term evaluation from the start of development. This will avoid any migration efforts later on.

For more information, see Database configuration for Neptune DXP - Open Edition.

Prerequisites

  • You have fulfilled the system requirements for running Neptune DXP - Open Edition under Windows.

  • You have identified general sizing requirements for your infrastructure resources to run Neptune DXP - Open Edition according to the Neptune sizing guide.

Procedure

  1. Download the .exe file for the Neptune DXP Installer – Open Edition (Windows) of the latest version of Neptune DXP - Open Edition from the product download section on Neptune DXP Portal.

  2. Run the .exe file of the Neptune DXP Installer – Open Edition (Windows).

    Result: The Neptune DXP Installer – Open Edition (Windows) opens on the welcome screen.

  3. In the Choose Your Runtime Installation Location screen, browse a location in your file directory to download Neptune DXP - Open Edition and select Next.

  4. In the Installation Mode screen, choose between Quick Installation and Advanced Installation, and select Next.

    The Quick Installation mode installs Neptune DXP - Open Edition with default settings. The Advanced Installation mode installs Neptune DXP - Open Edition using custom settings, for example, specific database configurations. The Quick Installation mode skips steps five to seven, and ten to eleven.

  5. In the Select Runtime Name screen, enter a meaningful name and description for Neptune DXP - Open Edition to have on runtime, and select Next.

  6. In the Choose the Runtime Port screen, enter a port on which Neptune DXP - Open Edition is to run, and select Next.

  7. In the Runtime Proxy Configuration screen, optionally enter URLs to start Neptune DXP - Open Edition according to your specific proxy scenario.

  8. In the Connect for Licence Retrieval screen, do one of the following:

    1. Retrieve your license for subsequent activation of Neptune DXP - Open Edition via your customer ID by either fetching the customer ID from the Neptune DXP Portal using your Neptune DXP Portal credentials, or

    2. Insert the customer ID directly in Customer ID, if you have the product license and corresponding customer ID already at hand, and select Next.

  9. If you select Fetch from the Neptune DXP Portal to sign in to your account, in the Retrieve a Product License screen that opens, in Customer ID, select the associated user for the Neptune DXP Portal that is connected to the customer ID for your Neptune DXP - Open Edition license. If you selected Generate Trial License in the previous screen, your associated email address to Neptune DXP Portal that is connected to the customer ID for your Neptune DXP - Open Edition trial license displays. If you do not select a customer ID in this step, you can still install Neptune DXP - Open Edition and allocate the customer ID for the license after installation. Select Next.

  10. In the Set up Your Database screen, select the database type on which Neptune DXP - Open Edition is to be installed, and select Next.

    The setup process installs Neptune DXP - Open Edition on an SQLite database by default if no other database type is selected.

  11. In the Database Configuration screen, enter the connection details for the selected database in the fields that display, for example the database name, test the database connection, and select Next.

  12. In the License Agreement screen, read through the end-user license agreement (EULA) and select I Agree.

  13. In Choose Installation Options, select whether you want to make Neptune DXP - Open Edition available to all users using the computer on which Neptune DXP - Open Edition is installed, or only for the local Windows user, and select Install.

    If you want to make Neptune DXP - Open Edition available to all users using the computer on which Neptune DXP - Open Edition is installed, you must run the instance as an admin user.

    Result:

    • The instance of Neptune DXP - Open Edition installs with your previously selected configurations in the selected installation location. The installation process may take around a minute.

    • The background setup script runs. You are prompted to upgrade the associated database using the latest version instance of Neptune DXP - Open Edition, whether you want to create a background service for the instance, and whether you want to start Neptune DXP - Open Edition directly after installation.

  14. In the Completing Neptune DXP - Open Edition Setup screen, select Finish.

Results

  • You have installed an instance of Neptune DXP - Open Edition according to your license and database configurations with the Neptune DXP Installer – Open Edition (Windows) either in the Quick Installation or Advanced Installation mode, depending on your use case.

Related topics