Skip to content

Commit e4cbabd

Browse files
authored
Create configurations.md (#469)
* Create configurations.md * fix spelling * added new words * added new configurations page + images + edit audit logs & sso * mispell * remove new line * enter missing
1 parent 938c57a commit e4cbabd

11 files changed

Lines changed: 184 additions & 43 deletions

.wordlist.txt

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -500,4 +500,10 @@ Unpublish
500500
workspaces
501501
RoleARN
502502
Multiline
503-
multiline
503+
multiline
504+
ElasticSearch
505+
DocsBot
506+
chatbot
507+
MSA
508+
GPT
509+
OpenAI

docs/admin-guide/appearance.md

Lines changed: 0 additions & 35 deletions
This file was deleted.

docs/admin-guide/configurations.md

Lines changed: 167 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
---
2+
sidebar_position: 1
3+
title: Configurations
4+
---
5+
6+
__Overview__
7+
8+
The Configuration page consolidates key system settings and administrative configurations for account management. This page replaces two older settings pages, streamlining access to critical configuration options
9+
10+
---
11+
12+
### 1. White Labeling
13+
14+
Customize the Torque interface with your organization's branding by uploading a custom logo. This ensures a **consistent and professional** look throughout the platform.
15+
16+
This feature allows you to:
17+
- Replace the default Torque logo across the system.
18+
- Upload three logo types: Favicon, Wide Logo, and Square Logo.
19+
20+
**How to upload your logo**
21+
22+
1. Navigate to **Configuration > White Labeling**.
23+
2. Upload all three recommended logo types:
24+
25+
- **Favicon** – Appears in the browser tab.
26+
- **Wide Logo** – This logo will appear in the header section of your website or application
27+
- **Square Logo** – This logo will appear in places where a square image is needed, such as social media profile pictures.
28+
29+
3. Confirm that your logo uploads successfully.
30+
31+
:::info 🔒 White Labeling is optionally available for **Enterprise plans only**.::::
32+
33+
---
34+
35+
### 2. Announcements
36+
37+
38+
Use the **Announcements** feature to display **important messages across the platform** with a banner at the top of every page.
39+
40+
This feature allows you to create and manage announcement banners to notify users about critical updates. You can:
41+
- Set banners for specific spaces or apply them globally.
42+
- Customize the message, and banner color.
43+
- Enable Maintenance Mode to prevent environment launches in selected spaces.
44+
45+
**How to set up an Announcement**
46+
47+
1. Navigate to **Configuration > Announcements**.
48+
2. Use the ‘Preview Mode’ toggle to see how your banner will eventually look like.
49+
3. Enter your message and customize the **banner color**.
50+
4. Choose specific **spaces** to display the announcement or apply it system-wide.
51+
5. Enable the **Maintenance Mode** if needed. This mode enables preventing selected spaces from launching new environments during your scheduled downtime.
52+
6. Save changes to instantly publish the announcement.
53+
54+
---
55+
56+
### 3. Audit Logs
57+
58+
Torque’s **Audit Logs** provide comprehensive tracking of key platform activities, helping you monitor user behavior, investigate security risks, and maintain compliance.
59+
Options include:
60+
- ElasticSearch: With built-in **Elastic Stack integration**, you can forward audit data for real-time analysis and reporting.
61+
- Torque Audit: Forward logs to Torque, and retain for 18 months..
62+
63+
**How to set up an Audit Log destination**
64+
📖 Learn more about [Torque Audit](https://docs.qtorque.io/governance/audit-log/audit-log-configuration)
65+
66+
:::info 🔒 Audit log integration is available for **Enterprise plans only** and requires a specific licensing feature.::::
67+
68+
---
69+
70+
### 4. Copilot Settings
71+
72+
Enable Torque’s AI-powered assistant to provide recommendations and enhance workflow automation, within your account.
73+
74+
These settings include 2 features:
75+
**1. Torque Copilot** – Easily navigate Torque with our AI chatbot, always accessible and leveraging the official documentation for swift exploration.
76+
(This feature is based on a 3rd party tool called DocsBot)
77+
![DocsBot](/img/docsbot.png)
78+
79+
**How to enable Torque Copilot**
80+
81+
1. Navigate to **Configuration > Copilot Settings**.
82+
2. Toggle on the ‘Torque Copilot’ toggle to show the AI chatbot button at the top header, next to the rest of the utilities.
83+
3. Toggle off to hide the AI chatbot and to prevent access from all users.
84+
85+
**2. Cloud Copilot** – Your internal AI assistance to create and customize Blueprints, auto-generate descriptions, and resolve live environment errors.
86+
This AI assistant tool is subject to the [Torque MSA](https://www.quali.com/legal-torque-master-subscription-agreement/) and requires user consent.
87+
88+
With this feature you can:
89+
- **Auto-generate descriptions** for blueprints, to effortlessly expand the details on every blueprint in the account.
90+
- **(Blueprint) Cloud Copilot** - Create and customize blueprints from your Building Blocks Library, using simple language prompts and the power of AI.
91+
![Cloud Copilot](/img/cloud_copilot_panel.png)
92+
93+
- **AI Insights** - Get AI assistant when you need it. Resolve issues in live environments, by clicking the “Get AI Insights” button, on every error log in your environment.
94+
![AI Insights](/img/ai_insights.png)
95+
96+
97+
98+
**How to Enable Cloud Copilot**
99+
100+
1. Navigate to **Configuration > Copilot Settings**.
101+
2. Under the ‘Cloud Copilot’ section > click on the **‘AI Provider’ button** to select where to host your AI Data while using Copilot:
102+
- Host in **Torque’s Open AI
103+
**There’s no further configuration, just click ‘Connect’
104+
- Host in your own **Azure OpenAI service
105+
**You’ll have to provide: API key, Endpoint URL, GPT-4o deployment name, and GPT-4o mini deployment name.
106+
- Host in your own **OpenAI
107+
**You’ll have to provide only the API key.
108+
3. To apply this settings, it requires a specific licensing feature - please contact us to enable Cloud Copilot for the account.
109+
4. Once your request was applied, and your selected provider was connected successfully, you’ll be able to enjoy the Cloud Copilot capabilities.
110+
5. You can toggle off to hide all the Cloud Copilot capabilities and prevent access from all users.
111+
112+
113+
---
114+
115+
116+
117+
### 5. SSO Login
118+
119+
Streamline authentication with Single Sign-On (SSO) integration.
120+
121+
**How to Enable SSO Login**
122+
123+
1. Navigate to **Configuration > SSO Login**.
124+
2. To enable SSO, click ‘Send a Request’ to connect with an account manager.
125+
126+
- 📖 [How SSO Configuration Works](https://docs.qtorque.io/admin-guide/sso)
127+
128+
:::info 🔒 SSO Login is optionally available for **Enterprise plans only**.::::
129+
130+
131+
---
132+
133+
134+
### 6. Email Reports
135+
Subscribe to the ‘Weekly Digest’, a summary email providing key account activity insights.
136+
Torque's weekly digest reports condense the most important information from a week's worth of data collected in Torque, making it easier for Torque administrators to quickly understand the most critical developments.
137+
Torque ‘Weekly Digest’ emails are being sent to Torque administrators and will highlight:
138+
139+
- Cloud usage
140+
- Torque users activity
141+
- Environments usage
142+
- Cloud Cost
143+
- Top used IaC modules
144+
- Top contributors to the operation
145+
![Weekly Digest Example](/img/mockup_weekly_digest.png)
146+
147+
**How to Enable Email Reports**
148+
149+
1. Navigate to **Configuration > Email Reports**.
150+
2. Toggle on the ‘Email Report’ toggle to subscribe to the ‘Weekly Digest’ email report
151+
3. Toggle off to unsubscribe
152+
153+
---
154+
155+
### 7. Approval Requests
156+
157+
Control the visibility of the Approval Requests page. Approval policies will still apply.
158+
159+
**How to Enable Approval Requests**
160+
161+
1. Navigate to **Configuration > Approval Requests**.
162+
2. Toggle the setting to **show or hide** the Approval Requests page.
163+
164+
:::info Notice that hiding the page does NOT prevent users from applying approval requests for launching, or extending environments.::::
165+
166+
167+

docs/admin-guide/sso.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ In this article:
3737
* IdP Issuer URI
3838
* IdP Single Sign-On URL
3939
* IdP Signature Certificate
40-
5. Go to the Quali Support Center and add a new ticket, requesting SSO integration:
40+
5. Go to __Configuration > SSO Login__ or go to the Quali Support Center and add a new ticket, requesting SSO integration:
4141
1. Click __+ Add__ in the top left corner.
4242
2. From the __Requester__ drop-down list, select __Torque__.
4343
3. From the __Form__ drop-down list, select __Torque Support Request__.

docs/governance/audit-log/audit-log-configuration.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,20 @@ title: Audit Log Configuration
77
* Working Elastic Stack server with internet access
88

99
## Configuration
10-
1. Go to __Administration > Audit Log__, and click __Add audit target__.
11-
2. Select __elasticsearch__ and fill in the details.
12-
> ![Locale Dropdown](/img/add-audit-target.png)
10+
1. Navigate to __Configuration > Audit Log__, and click __Add Audit Target__.
11+
2. Select one of the options:
12+
- __Torque Audit__: Forward logs to Torque, and retain for 18 months.
13+
- __ElasticSearch__: With built-in Elastic Stack integration, you can forward audit data for real-time analysis and reporting.
14+
3. When selecting ElasticSearch, please fill in the details:
15+
> ![Locale Dropdown](/img/audit_logs_wizard.png)
1316
* __Destination URL__ of the elastic server
1417
* __Username/Password__ of the elastic Stack admin
1518
* __Certificate__: You can optionally configure SSL connection by specifying the http ca __Certificate__.
1619

17-
3. Click __Send a test event__, and click __Save__.
18-
4. In Kibana, go to __Management > Stack Management > Index Management__ and make sure you see the __quali__ index.
20+
4. Click __Send a test event__, and click __Save__.
21+
5. In Kibana, go to __Management > Stack Management > Index Management__ and make sure you see the __quali__ index.
1922
> ![Locale Dropdown](/img/quali-index.png)
20-
5. Go to __Management > Stack Management > Index Patterns__ and create a "quali" index pattern.
23+
6. Go to __Management > Stack Management > Index Patterns__ and create a "quali" index pattern.
2124
> ![Locale Dropdown](/img/quali-index-pattern.png)
2225
2326
Congratulations! Audit Log is configured and collecting Torque events.

static/img/add-audit-target.png

-52.3 KB
Binary file not shown.

static/img/ai_insights.png

17.6 KB
Loading

static/img/audit_logs_wizard.png

210 KB
Loading

static/img/cloud_copilot_panel.png

189 KB
Loading

static/img/docsbot.png

260 KB
Loading

0 commit comments

Comments
 (0)