ns8-repod

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

Install

Instantiate the module with:

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

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

{"module_id": "repod1", "image_name": "repod", "image_url": "ghcr.io/nethserver/repod:latest"}

Configure

Let's assume that the repod instance is named repod1.

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/repod1/configure-module --data '{}'

The above command will:

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

Send a test HTTP request to the repod backend service:

curl http://127.0.0.1/repod/

Uninstall

To uninstall the instance:

remove-module --no-preserve repod1

Testing

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

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

The tests are made using Robot Framework