Install Neptune DXP - Open Edition on macOS

This installation procedure describes the basic minimum steps required to run Neptune DXP - Open Edition locally for nonproductive purposes.

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.

  1. Download the latest version of Neptune DXP - Open Edition from the product download section on Neptune DXP Portal.

  2. Unzip the ZIP file.

  3. Right-click on the unzipped folder and select Services → New Terminal at Folder.

  4. In the Terminal, run ./planet9-darwin.

    Result: A macOS notification will show that the planet9-darwin file cannot be opened.

  5. Continue with adjusting the security settings for the planet9-darwin file, as described in the following section.

Adjust security settings for the planet9-darwin file

The following instructions are valid for installations before Neptune DXP - Open Edition version 23.10.10.

  1. In the macOS notification showing that the planet9-darwin file cannot be opened, select Okay.

  2. Go to System Settings → Privacy & Security.

  3. In the Security section, you will find a notification that the planet9-darwin file was blocked from use.

  4. Select Allow Anyway.

  5. In the Terminal, run ./planet9-darwin again.

    Result: A macOS notification prompts you to confirm you want to open the planet9-darwin file.

  6. Select Open.

    Result: A macOS notification will show that the node_sqlite3.node file cannot be opened.

  7. Continue with adjusting the security settings for the embedded SQLite database, as described in the following section.

Adjust security settings for the embedded SQLite database

The following instructions are valid for installations before Neptune DXP - Open Edition version 23.10.10.

  1. In the macOS notification showing that the node_sqlite3.node file cannot be opened, select Okay.

  2. Go to System Settings → Privacy & Security.

  3. In the Security section, you will find a notification that the node_sqlite3.node file was blocked from use.

  4. Select Allow Anyway.

  5. In the Terminal, run ./planet9-darwin again.

    Result: The folder containing the executable file, will now be populated with the files generated by the platform.

  6. Check in your installation folder that the following additional folders were added: db, webapp, config, and log.

Open Neptune DXP - Open Edition in your browser

  1. Open your browser and go to http://localhost:8080.

    If the command line interface is closed, the node session will be terminated, and you will lose access to the platform via the browser.

    1. The default username is admin.

    2. The default password is admin.

  2. You can safely end your session using the keyboard shortcut CMD + C in the Terminal.