This is a template module for NethServer 8. To start a new module from it:

1. Click on Use this template. Name your repo with ns8- prefix (e.g. ns8-mymodule). Do not end your module name with a number, like ns8-baaad2!

2. An automated initialization workflow starts: wait for its completion. You can follow the run inside the "Actions" tab, the workflow is named "Initial commit"

3. You can now clone the repository

4. Edit this README.md file, by replacing this section with your module description

5. Commit and push your local changes

Instantiate the module with:

add-module ghcr.io/nethserver/newui:latest 1

The output of the command will return the instance name. Output example:

{"module_id": "newui1", "image_name": "newui", "image_url": "ghcr.io/nethserver/newui:latest"}

Let's assume that the newui instance is named newui1.

Launch configure-module, by setting the following parameters:

• <MODULE_PARAM1_NAME>: <MODULE_PARAM1_DESCRIPTION>
• <MODULE_PARAM2_NAME>: <MODULE_PARAM2_DESCRIPTION>
• ...

Example:

api-cli run module/newui1/configure-module --data '{}'

The above command will:

• start and configure the newui instance
• (describe configuration process)
• ...

Send a test HTTP request to the newui backend service:

curl http://127.0.0.1/newui/

To uninstall the instance:

remove-module --no-preserve newui1

Test the module using the test-module.sh script:

./test-module.sh <NODE_ADDR> ghcr.io/nethserver/newui:latest

The tests are made using Robot Framework