Skip to content

Commit

Permalink
Update readme info
Browse files Browse the repository at this point in the history
  • Loading branch information
compgeniuses committed Aug 7, 2024
1 parent 0fbba6f commit 65e7033
Showing 1 changed file with 4 additions and 30 deletions.
34 changes: 4 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,18 @@
# ns8-docuseal

This is a template module for [NethServer 8](https://github.com/NethServer/ns8-core).
This is a Docuseal 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

Expand Down Expand Up @@ -83,7 +57,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

Expand Down

0 comments on commit 65e7033

Please sign in to comment.