Module settings and the installation wizard

Where to enter the module's basic data (including the NAV software details), how to check the server environment, how to run the installation, and where to copy the scheduler command from.

On the module's settings page you enter the basic data the system needs, check whether the server meets the requirements, and start or repeat the installation. You find the page among the extensions, in the list of modules.

Before you start

  • Saving the settings needs modify permission on the module's settings page.
  • The actions of the System check & installation tab are for the super administrator only.

Saving the settings

  1. Open Extensions → Modules and click the blue pencil icon in the system module's row.
  2. Set the switches on the General, Invoice and Documents tabs.
  3. On the NAV tab fill in the software details: NAV url, NAV software ID, NAV software NAME, NAV software operation, NAV software devname, NAV software devcontact, NAV software taxnumber. All of them are required.
  4. Click Save.

Environment check and installation

  1. Open the System check & installation tab. The table shows the PHP version, the framework version, free disk space, required libraries, PHP extensions and programs, the network and the database schema.
  2. Re-check runs the check again; Check with connections also tries the external connections. Details opens a row's details.
  3. If an external library is missing, click Install libraries.
  4. Start the installation with the tab's install button. The system works through the steps in order: Checking required conditions, Third-party libraries (Composer), Database schema, Database migrations, Default settings, Events, cron jobs, startup, Finishing and integrity check. On an installed system Re-run installation (repair) repeats the same.
  5. Export database structure downloads the database structure with the system master data, without customer or personal data.
  6. Cron command copies the scheduler command to the clipboard. There are two forms: the command-line call (recommended) and the web address with a secret. Paste it into your hosting's scheduled tasks.

Requirements

ItemMinimumRecommended
PHP8.0.08.2.0
Framework4.0.24.0.2
Free disk space300 MB1 GB

Installation-specific settings

The Installation-specific settings tab holds data that belongs to this installation only and never goes into the software package, for example the mailbox logins of the mail processors. Save a key with Save and remove it with Delete.

If the module is uninstalled, the system removes its event handlers, scheduled tasks and startup entries, but not the business data.

Example

After moving to a new server, the administrator of Sample Ltd. opens the System check & installation tab. The table shows a missing external library; after Install libraries, Re-check runs without errors. Re-run installation (repair) then applies the migrations, and finally the command copied with Cron command is pasted into the hosting scheduler.

Related topics: installation scheduling