From 4b713ad61275c129aa090ec4d90e81b72e1a20b9 Mon Sep 17 00:00:00 2001 From: kemboi22 Date: Thu, 15 Aug 2024 07:12:07 +0300 Subject: [PATCH] feat: updated README.md --- README.md | 31 +++---------------------------- 1 file changed, 3 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index a940cd9..420fdc3 100644 --- a/README.md +++ b/README.md @@ -3,42 +3,17 @@ This is a template module for [NethServer 8](https://github.com/NethServer/ns8-core). To start a new module from it: -1. Click on [Use this template](https://github.com/NethServer/ns8-docuseal/generate). - Name your repo with `ns8-` prefix (e.g. `ns8-mymodule`). - Do not end your module name with a number, like ~~`ns8-baaad2`~~! - -1. Clone the repository, enter the cloned directory and - [configure your GIT identity](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup#_your_identity) - -1. Rename some references inside the repo: - ``` - modulename=$(basename $(pwd) | sed 's/^ns8-//') && - git mv imageroot/systemd/user/docuseal.service imageroot/systemd/user/${modulename}.service && - git mv imageroot/systemd/user/docuseal-app.service imageroot/systemd/user/${modulename}-app.service && - git mv tests/docuseal.robot tests/${modulename}.robot && - sed -i "s/docuseal/${modulename}/g" $(find .github/ * -type f) && - git commit -a -m "Repository initialization" - ``` - -1. Edit this `README.md` file, by replacing this section with your module - description - -1. Adjust `.github/workflows` to your needs. `clean-registry.yml` might - need the proper list of image names to work correctly. Unused workflows - can be disabled from the GitHub Actions interface. - -1. Commit and push your local changes ## Install Instantiate the module with: - add-module ghcr.io/compgeniuses/docuseal:latest 1 + add-module ghcr.io/geniusdynamics/docuseal:latest 1 The output of the command will return the instance name. Output example: - {"module_id": "docuseal1", "image_name": "docuseal", "image_url": "ghcr.io/compgeniuses/docuseal:latest"} + {"module_id": "docuseal1", "image_name": "docuseal", "image_url": "ghcr.io/geniusdynamics/docuseal:latest"} ## Configure @@ -83,7 +58,7 @@ To uninstall the instance: To Update the instance: - api-cli run update-module --data '{"module_url":"ghcr.io/compgeniuses/docuseal:latest","instances":["docuseal1"],"force":true}' + api-cli run update-module --data '{"module_url":"ghcr.io/geniusdynamics/docuseal:latest","instances":["docuseal1"],"force":true}' ## Smarthost setting discovery