You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Email configuration is automatically discovered from the system smarthost settings. The following SMTP settings are configured automatically:
54
+
55
+
- SMTP host, port, username, and password
56
+
- SMTP encryption method (TLS/SSL)
57
+
- TLS verification settings
58
+
59
+
### Google SSO (Optional)
60
+
61
+
| Parameter | Type | Default | Description |
62
+
|-----------|------|---------|-------------|
63
+
|`allow_google_sso`| boolean |`false`| Enable Google SSO authentication |
64
+
|`google_sso_client_id`| string |`""`| Google OAuth client ID |
65
+
|`google_sso_secret`| string |`""`| Google OAuth client secret |
66
+
67
+
### SSO Auto-Creation (Optional)
68
+
69
+
| Parameter | Type | Default | Description |
70
+
|-----------|------|---------|-------------|
71
+
|`sso_auto_create_user`| boolean |`true`| Automatically create users from SSO authentication |
72
+
73
+
### OIDC Role Patterns (Optional)
74
+
75
+
Configure role mapping patterns for OpenID Connect authentication:
76
+
77
+
| Parameter | Type | Default | Description |
78
+
|-----------|------|---------|-------------|
79
+
|`oidc_role_new_hire_pattern`| string |`""`| Regex pattern to match new hire roles |
80
+
|`oidc_role_admin_pattern`| string |`""`| Regex pattern to match admin roles |
81
+
|`oidc_role_manager_pattern`| string |`""`| Regex pattern to match manager roles |
82
+
|`oidc_role_path_in_return`| string |`"groups"`| JSON path in OIDC response for roles |
83
+
84
+
### Authentication Providers (Optional)
85
+
86
+
| Parameter | Type | Default | Description |
87
+
|-----------|------|---------|-------------|
88
+
|`socialaccount_providers`| object |`{}`| JSON object defining social authentication providers |
89
+
|`allauth_providers`| string |`""`| JSON configuration for additional authentication providers |
90
+
91
+
### Example Configuration
92
+
93
+
```bash
31
94
api-cli run configure-module --agent module/chiefonboarding1 --data - <<EOF
32
95
{
33
96
"host": "chiefonboarding.domain.com",
34
97
"http2https": true,
35
-
"lets_encrypt": false
98
+
"lets_encrypt": false,
99
+
"allow_google_sso": true,
100
+
"google_sso_client_id": "your-client-id",
101
+
"google_sso_secret": "your-client-secret",
102
+
"sso_auto_create_user": true,
103
+
"oidc_role_new_hire_pattern": ".*new_hire.*",
104
+
"oidc_role_admin_pattern": ".*admin.*",
105
+
"oidc_role_manager_pattern": ".*manager.*",
106
+
"oidc_role_path_in_return": "groups",
107
+
"socialaccount_providers": {},
108
+
"allauth_providers": ""
36
109
}
37
110
EOF
38
111
```
39
112
40
-
The above command will:
41
-
- start and configure the chiefonboarding instance
42
-
- configure a virtual host for trafik to access the instance
113
+
**The above command will:**
43
114
44
-
## Get the configuration
45
-
You can retrieve the configuration with
115
+
- Configure the chiefonboarding instance
116
+
- Configure a virtual host for traefik to access the instance
46
117
47
-
```
118
+
---
119
+
120
+
## Get the Configuration
121
+
122
+
Retrieve the configuration with:
123
+
124
+
```bash
48
125
api-cli run get-configuration --agent module/chiefonboarding1
49
126
```
50
127
128
+
---
129
+
51
130
## Uninstall
52
131
53
132
To uninstall the instance:
54
133
55
-
remove-module --no-preserve chiefonboarding1
134
+
```bash
135
+
remove-module --no-preserve chiefonboarding1
136
+
```
137
+
138
+
---
56
139
57
140
## Update
58
141
59
-
To Update the instance:
142
+
To update the instance:
143
+
144
+
```bash
145
+
api-cli run update-module --data '{"module_url":"ghcr.io/geniusdynamics/chiefonboarding:latest","instances":["chiefonboarding1"],"force":true}'
146
+
```
60
147
61
-
api-cli run update-module --data '{"module_url":"ghcr.io/geniusdynamics/chiefonboarding:latest","instances":["chiefonboarding1"],"force":true}'
148
+
---
62
149
63
-
## Smarthost setting discovery
150
+
## Smarthost Setting Discovery
64
151
65
-
Some configuration settings, like the smarthost setup, are not part of the
66
-
`configure-module` action input: they are discovered by looking at some
67
-
Redis keys. To ensure the module is always up-to-date with the
68
-
centralized [smarthost
69
-
setup](https://geniusdynamics.github.io/ns8-core/core/smarthost/) every time
70
-
chiefonboarding starts, the command `bin/discover-smarthost` runs and refreshes
71
-
the `state/smarthost.env` file with fresh values from Redis.
152
+
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://geniusdynamics.github.io/ns8-core/core/smarthost/) every time chiefonboarding starts, the command `bin/discover-smarthost` runs and refreshes the `state/smarthost.env` file with fresh values from Redis.
72
153
73
-
Furthermore if smarthost setup is changed when chiefonboarding is already
74
-
running, the event handler `events/smarthost-changed/10reload_services`
75
-
restarts the main module service.
154
+
Furthermore if smarthost setup is changed when chiefonboarding is already running, the event handler `events/smarthost-changed/10reload_services` restarts the main module service.
76
155
77
156
See also the `systemd/user/chiefonboarding.service` file.
78
157
79
-
This setting discovery is just an example to understand how the module is
80
-
expected to work: it can be rewritten or discarded completely.
158
+
> This setting discovery is just an example to understand how the module is expected to work: it can be rewritten or discarded completely.
159
+
160
+
---
81
161
82
162
## Debug
83
163
84
-
some CLI are needed to debug
164
+
### Check Environment Variables
165
+
166
+
The module runs under an agent that initiates a lot of environment variables (in `/home/chiefonboarding1/.config/state`). Verify them on the root terminal:
85
167
86
-
- The module runs under an agent that initiate a lot of environment variables (in /home/chiefonboarding1/.config/state), it could be nice to verify them
87
-
on the root terminal
168
+
```bash
169
+
runagent -m chiefonboarding1 env
170
+
```
171
+
172
+
### Use runagent
173
+
174
+
Become runagent for testing scripts and initiate all environment variables:
88
175
89
-
`runagent -m chiefonboarding1 env`
176
+
```bash
177
+
runagent -m chiefonboarding1
178
+
```
90
179
91
-
- you can become runagent for testing scripts and initiate all environment variables
0 commit comments