Run Neptune DXP - Open Edition

  1. Start Neptune DXP - Open Edition.

  2. Open your browser and go to the URL corresponding to your server:

  3. Sign in with the username admin and the default password admin.

Run Neptune DXP - Open Edition server in production

When you deploy a Neptune DXP - Open Edition instance on a remote system, do not run the Neptune DXP - Open Edition instance as an “admin”, “root”, or any other super admin-type privileged user. Depending on the system, this results in Neptune DXP - Open Edition probably (depending on OS) not being able to bind by default to port 80 (HTTP) or 443 (HTTPS). To bind Neptune DXP - Open Edition to these default ports, we advise to use a web server like nginx. This web server can bind to the ports 80 and 443 and forwards requests to the Neptune DXP - Open Edition instance.

Use nginx

You can use nginx to cache any media request. By this, less data traffic is put on the Neptune DXP - Open Edition instance for serving static assets, for example, images. nginx has a free open source version available for commercial use and can be downloaded at nginx.

Store custom npm modules

We recommend that you create a folder where all custom npm modules are installed. You can configure Neptune DXP - Open Edition instance to use this folder in Settings > Customizing > General.

Run Neptune DXP - Open Edition server on a remote system

To run Neptune DXP - Open Edition server on a remote system, you need to be able to disconnect from the system without detaching the process. There are two options to do this:

Option 1: Forking

Fork the system so that it can run as a background process or as a service. The benefit of running as a service is that Neptune DXP - Open Edition instance can restart in the event of a Neptune DXP - Open Edition application crash and auto-start after booting. IMPORTANT: Make sure that the user running Neptune DXP - Open Edition service has the following properties and permissions:

  • The user can access the custom npm folder.

  • The user set the path to npm.

  • The user has the permissions for Neptune DXP - Open Edition executable (see installation step).

A configuration for a Linux service would look as follows:

[Unit]

Description=Neptune DXP - Open Edition

[Service] ExecStart=/var/planet9/planet9-linux
Restart=always
User=MyUser
Group=nobody
# Notice the npm path
Environment=PATH=/home/MyUser/.nvm/versions/node/v10.16.3/bin:/usr/
bin:/usr/local/bin
Environment=NODE_ENV=production
WorkingDirectory=/var/planet9

[Install] WantedBy=multi-user.target

Option 2: Use a terminal multiplexer

You can use a terminal multiplexer, for example, screen or tmux. To install tmux on Linux, type the following:

sudo yum install tmux

How to use tmux on Linux:

  1. Start tmux on your computer.

  2. Start Neptune DXP - Open Edition. From this point on, even if you are disconnected from the server, Neptune DXP - Open Edition continues to run.

  3. After you have started Neptune DXP - Open Edition, disconnect from tmux: Type c-b d (or c- space d). 'd' stands for disconnect.

  4. The next time you connect to Neptune DXP - Open Edition and want to continue where you left, start the server and type tmux ls. You see the running tmux sessions and type tmux attach to it.

You can run Neptune DXP - Open Edition without performing above steps. As soon as you lose the connection to the remote system, the parent process stops and only the forked system processes continue running. This means that you cannot see the system processes running inside Neptune DXP - Open Edition.

Related topics