Creating Module Instances

The first step when using RestApiServer after N3uron installation is to create a RestApiServer module:

• Open N3uron and go to the “Config” menu.
• Click on “Modules”, then create a new module. This instance can be given any name (except names with special characters like ‘.’, ‘/’, etc.), although users are recommended to name instances in a similar way to the name of the module being created for easy identification. In this example, it has been named RestApiServer.

Figure 1: Creating new module instances

By setting the module type to RestApiServer, the created instance will automatically become a RestApiServer instance. Once saved, RestApiServer should appear in bold in the module list because there are unsaved changes.Figure 2: Setting the instance type

Each instance can also be configured with the following options:

• Required: When set to enabled and when this module is receiving data from other N3uron nodes, all links will be paused whilst the module is offline to avoid data loss. If disabled, this module will have no effect on links when offline.
• Auto-start: This section controls how the module behaves when the N3uron service is started (which also includes service restarts).
  • Enabled: If true, the module will automatically start when the N3uron service starts. Otherwise, the module must be started manually.
  • Start delay: When auto-start is enabled, this setting is used to control how much delay there should be between starting the N3uron service and starting the module. This value is displayed in milliseconds.
• Monitor: This section is used to monitor the status of each module, as well as to enable automatic restart if the module goes offline.
  • Automatic restart: If true, whenever the module goes offline (except when manually stopped by the user) the module will automatically restart.
  • Restart delay: Determines the delay before restarting the module after going offline.