Skip to content

Commit

Permalink
feat: updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kemboi22 committed Aug 4, 2024
1 parent 21529ca commit d898435
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@

Instantiate the module with:

add-module ghcr.io/gesniusdynamics/linkstack:latest 1
add-module ghcr.io/geniusdynamics/linkstack:latest 1

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

{"module_id": "linkstack1", "image_name": "linkstack", "image_url": "ghcr.io/gesniusdynamics/linkstack:latest"}
{"module_id": "linkstack1", "image_name": "linkstack", "image_url": "ghcr.io/geniusdynamics/linkstack:latest"}

## Configure

Expand Down Expand Up @@ -45,7 +45,12 @@ You can retrieve the configuration with
```
api-cli run get-configuration --agent module/linkstack1
```
## Update
Update instance

```shell
api-cli run update-module --data '{"module_url":"ghcr.io/geniusdynamics/linkstack:latest","instances":["linkstack1"],"force":true}'
```
## Uninstall

To uninstall the instance:
Expand All @@ -58,7 +63,7 @@ Some configuration settings, like the smarthost setup, are not part of the
`configure-module` action input: they are discovered by looking at some
Redis keys. To ensure the module is always up-to-date with the
centralized [smarthost
setup](https://gesniusdynamics.github.io/ns8-core/core/smarthost/) every time
setup](https://geniusdynamics.github.io/ns8-core/core/smarthost/) every time
linkstack starts, the command `bin/discover-smarthost` runs and refreshes
the `state/smarthost.env` file with fresh values from Redis.

Expand Down Expand Up @@ -130,7 +135,7 @@ podman exec -ti linkstack-app sh
Test the module using the `test-module.sh` script:


./test-module.sh <NODE_ADDR> ghcr.io/gesniusdynamics/linkstack:latest
./test-module.sh <NODE_ADDR> ghcr.io/geniusdynamics/linkstack:latest

The tests are made using [Robot Framework](https://robotframework.org/)

Expand Down

0 comments on commit d898435

Please sign in to comment.