Grist

This is a template module for [2FAuth](https://docs.2fauth.app/).
To start a new module from it:
 
 
## Install
 
Instantiate the module with:
 
    add-module ghcr.io/geniusdynamics/2fauth:latest 1
 
The output of the command will return the instance name.
Output example:
 
    {"module_id": "2fauth1", "image_name": "2fauth", "image_url": "ghcr.io/geniusdynamics/2fauth:latest"}
 
## Configure
 
Let's assume that the mattermost instance is named `2fauth1`.
 
Launch `configure-module`, by setting the following parameters:
- `host`: a fully qualified domain name for the application
- `http2https`: enable or disable HTTP to HTTPS redirection (true/false)
- `lets_encrypt`: enable or disable Let's Encrypt certificate (true/false)
 
 
Example:
 
```
api-cli run configure-module --agent module/2fauth1 --data - <<EOF
{
  "host": "2fauth.domain.com",
  "http2https": true,
  "lets_encrypt": false
}
EOF
```
 
The above command will:
- start and configure the 2fauth instance
- configure a virtual host for trafik to access the instance
 
## Get the configuration
You can retrieve the configuration with
 
```
api-cli run get-configuration --agent module/2fauth1
```
 
## Uninstall
 
To uninstall the instance:
 
    remove-module --no-preserve 2fauth1
 
## Update
 
update a module
 
```shell
 api-cli run update-module --data '{"module_url":"ghcr.io/geniusdynamics/2fauth:latest","instances":["2fauth11"],"force":true}'
 
```
 
 
## Smarthost setting discovery
 
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://nethserver.github.io/ns8-core/core/smarthost/) every time
2fauth starts, the command `bin/discover-smarthost` runs and refreshes
the `state/smarthost.env` file with fresh values from Redis.
 
Furthermore if smarthost setup is changed when 2fauth is already
running, the event handler `events/smarthost-changed/10reload_services`
restarts the main module service.
 
See also the `systemd/user/2fauth.service` file.