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
The **Administration** section is accessed via the main sidebar and lives at `/admin-settings`. It manages users, access control, API credentials, global configuration, and system diagnostics.
76
+
77
+
:::info Keycloak mode
78
+
When Keycloak is enabled (`turing.keycloak=true`), the **Users**, **Groups**, and **Roles** subsections are hidden — identity and access management is fully delegated to Keycloak. See [Security & Keycloak](./security-keycloak.md).
79
+
:::
80
+
81
+
---
82
+
83
+
#### Users
84
+
85
+
Lists all local user accounts in the system.
86
+
87
+
**Form fields:**
88
+
89
+
| Field | Description |
90
+
|---|---|
91
+
| Avatar | Profile picture |
92
+
| Username | Unique login identifier |
93
+
| First Name / Last Name | Display name |
94
+
| Email | User's email address |
95
+
| Password | Account password |
96
+
97
+
**Tabs:**
98
+
99
+
| Tab | Description |
100
+
|---|---|
101
+
|**Groups**| Add or remove the user from groups |
102
+
|**Roles**| Displays roles inherited from the user's groups (read-only) |
103
+
104
+
---
105
+
106
+
#### Groups
107
+
108
+
Organises users into groups for role-based access control.
109
+
110
+
**Form fields:**
111
+
112
+
| Field | Description |
113
+
|---|---|
114
+
| Name | Group name |
115
+
| Description | Purpose or scope of the group |
116
+
117
+
**Tabs:**
118
+
119
+
| Tab | Description |
120
+
|---|---|
121
+
|**Users**| Add or remove members of this group |
122
+
|**Roles**| Assign or remove roles granted to this group |
123
+
124
+
---
125
+
126
+
#### Roles
127
+
128
+
Defines permissions that can be assigned to groups.
129
+
130
+
| Field | Description |
131
+
|---|---|
132
+
| Name | Role identifier |
133
+
| Description | What this role permits |
134
+
135
+
---
136
+
137
+
#### API Tokens
138
+
139
+
Manages API tokens used to authenticate REST API requests. Every token is passed in the `Key` request header.
140
+
141
+
**Form fields:**
142
+
143
+
| Field | Description |
144
+
|---|---|
145
+
| Title | A human-readable name for the token |
146
+
| Description | Purpose or owner of this token |
147
+
148
+
:::info
149
+
The token value is generated automatically on creation and displayed once with a copy button. It cannot be retrieved again — store it securely.
150
+
:::
151
+
152
+
**Using the token in API requests:**
153
+
154
+
```bash
155
+
curl -X GET "http://localhost:2700/api/sn/Sample/search?q=cloud&_setlocale=en_US" \
156
+
-H "Key: <YOUR_API_TOKEN>"
157
+
```
158
+
159
+
---
160
+
161
+
#### Global Settings
162
+
163
+
The central configuration panel for defaults and external service integrations. Divided into four sections:
164
+
165
+
##### General
166
+
167
+
| Field | Description |
168
+
|---|---|
169
+
| Decimal Separator | Choose between period (`.`) and comma (`,`) for numeric display |
170
+
| Python Path | Absolute path to the Python executable (required for Python-based processing) |
171
+
172
+
##### LLM Settings
173
+
174
+
| Field | Description |
175
+
|---|---|
176
+
| Default LLM Instance | The LLM used when no site-level instance is configured |
177
+
| Response Cache | Enable caching of LLM responses to reduce latency and cost |
178
+
| Cache Duration | How long cached responses are retained |
179
+
| Regenerate Cache | Button to manually invalidate and rebuild the response cache |
180
+
181
+
:::warning
182
+
Caching LLM responses improves performance but may return stale answers if the underlying content changes frequently. Tune the duration to match your content update cadence.
183
+
:::
184
+
185
+
##### RAG Settings
186
+
187
+
| Field | Description |
188
+
|---|---|
189
+
| Enable RAG Globally | Master switch for Retrieval-Augmented Generation across all sites |
190
+
| Default Embedding Model | The model used to vectorize documents at indexing time and queries at search time |
191
+
| Default Embedding Store | The vector store for persisting embeddings (ChromaDB, PgVector, or Milvus) |
192
+
193
+
:::warning
194
+
Changing the Default Embedding Model invalidates all existing embeddings. All indexed content must be re-indexed after changing this setting.
195
+
:::
196
+
197
+
:::note
198
+
The RAG Settings section is only visible if an embedding store is configured and available. If MinIO is not configured, the Knowledge Base and related RAG options will not appear.
199
+
:::
200
+
201
+
##### Email Settings
202
+
203
+
Used by Turing ES to send notifications and test email connectivity.
204
+
205
+
| Field | Description |
206
+
|---|---|
207
+
| Provider | Email service provider (e.g., Brevo) |
208
+
| API Key | API key for the email provider |
209
+
| Sender Email | The `From` email address |
210
+
| Sender Name | The display name shown to recipients |
211
+
| Recipient Email | Default destination for test emails |
212
+
| Send Test Email | Button to send a test message and verify configuration |
213
+
214
+
---
215
+
216
+
#### System Information
217
+
218
+
A diagnostic panel to monitor the health of the Turing ES instance. Divided into two tabs:
219
+
220
+
##### Overview Tab
221
+
222
+
| Item | Description |
223
+
|---|---|
224
+
| Application Version | Current Turing ES build version |
225
+
| Java Version | JVM version in use |
226
+
| Operating System | OS name and version |
227
+
| Database Status | Connection status of the primary database |
228
+
| RAM Usage | Current and total system memory |
229
+
| JVM Heap | Used and available JVM heap space |
230
+
| Disk Usage | Available storage on the host volume |
231
+
| MongoDB Status | Connected / disconnected (shown only if MongoDB is enabled) |
232
+
| MinIO Status | Connected / disconnected (shown only if MinIO is enabled) |
233
+
234
+
##### System Variables Tab
235
+
236
+
A searchable table of all JVM properties and environment variables active at runtime. Useful for verifying configuration at deployment.
0 commit comments