Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions confluence-mdx/var/pages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -256,36 +256,36 @@
- "user-manual"
- "workflow"
- "requesting-ip-registration"
- "page_id": "568918170"
"title": "결재 부가 기능 (대리 결재, 재상신 등)"
"title_orig": "결재 부가 기능 (대리 결재, 재상신 등)"
- "page_id": "1070006273"
"title": "DB 정책 예외 요청하기 (DB Policy Exception Request)"
"title_orig": "DB 정책 예외 요청하기 (DB Policy Exception Request)"
"breadcrumbs":
- "사용자 매뉴얼"
- "Workflow"
- "결재 부가 기능 (대리 결재, 재상신 등)"
- "DB 정책 예외 요청하기 (DB Policy Exception Request)"
"breadcrumbs_en":
- "User Manual"
- "Workflow"
- "Approval Additional Features (Proxy Approval, Resubmission, etc.)"
- "Requesting DB Policy Exception"
"path":
- "user-manual"
- "workflow"
- "approval-additional-features-proxy-approval-resubmission-etc"
- "page_id": "1070006273"
"title": "DB 정책 예외 요청하기 (DB Policy Exception Request)"
"title_orig": "DB 정책 예외 요청하기 (DB Policy Exception Request)"
- "requesting-db-policy-exception"
- "page_id": "568918170"
"title": "결재 부가 기능 (대리 결재, 재상신 등)"
"title_orig": "결재 부가 기능 (대리 결재, 재상신 등)"
"breadcrumbs":
- "사용자 매뉴얼"
- "Workflow"
- "DB 정책 예외 요청하기 (DB Policy Exception Request)"
- "결재 부가 기능 (대리 결재, 재상신 등)"
"breadcrumbs_en":
- "User Manual"
- "Workflow"
- "Requesting DB Policy Exception"
- "Approval Additional Features (Proxy Approval, Resubmission, etc.)"
"path":
- "user-manual"
- "workflow"
- "requesting-db-policy-exception"
- "approval-additional-features-proxy-approval-resubmission-etc"
- "page_id": "544380204"
"title": "Database Access Control"
"title_orig": "Database Access Control"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -797,7 +797,7 @@ After entering all desired information, click the `Preview` button to preview th

Click the `Save` button to save the report task and return to the list.

### Duplicate Report<Badge color="grey">10.2.2</Badge>
### Duplicate Report <Badge color="grey">10.2.2</Badge>

<figure data-layout="center" data-align="center">
<img src="/administrator-manual/audit/reports/reports/screenshot-20241223-104529.png" alt="Administrator &gt; Audit &gt; Reports &gt; Reports - Duplicate Task" width="589" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -447,7 +447,7 @@ File transfer execution notification via SFTP
* Even if targets are duplicated due to multiple selection, alert is sent only once
* All Connections (*) : Creates alert conditions for all future connections

#### K8s API Request<Badge color="grey">10.2.2</Badge>
#### K8s API Request <Badge color="grey">10.2.2</Badge>

Kubernetes API request notification

Expand All @@ -462,7 +462,7 @@ Kubernetes API request notification
* Currently supported - `pods`, `pods/exec`, `pods/log`, `pods/portforward`, `services`, `ingresses`, `deployments`, `replicasets`, etc. (24 types total)
* All Resources (*) : Creates alert conditions for all future resource types

#### Data Access<Badge color="grey">11.1.0</Badge>
#### Data Access <Badge color="grey">11.1.0</Badge>

<Callout type="info">
This can only be used when the New DAC Policy Management feature is enabled in Databases &gt; General &gt; Configurations and related policies exist.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,21 +95,21 @@ After moving to the Server Agent installation file location in CMD, execute the

1. Access the Administrator &gt; Servers &gt; Connection Management &gt; Server Agents for RDP page.
2. Click the `Verify Deletion Key` button in the top right.
3. Record the confirmed Deletion Key.
3. Record the confirmed `Deletion Key`.
4. Access the Windows Server console.
5. Access Control Panel &gt; Add/Remove Programs menu and delete QueryPie Server Agent.
6. Enter the Deletion Key recorded in step 3 in the password input field.
6. Enter the `Deletion Key` recorded in step 3 in the password input field.
7. Access QueryPie web.
8. Navigate to Administrator &gt; Servers &gt; Connection Management &gt; Server Agents for RDP menu.
9. Check the checkbox on the left of the target server to delete in the table and delete through the `Delete` button.


<Callout type="info">
Deletion Key changes daily, and deletion is only possible when the date of the server running QueryPie and the date of the target Windows server for deletion are the same.
`Deletion Key` changes daily, and deletion is only possible when the date of the server running QueryPie and the date of the target Windows server for deletion are the same.
</Callout>

<Callout type="important">
**When Deletion Key is Incorrect in Windows**
* Check if the Deletion Key was received from the connected QueryPie.
**When** `Deletion Key` **is Incorrect in Windows**
* Check if the `Deletion Key` was received from the connected QueryPie.
* Check if the date of the server running QueryPie and the date of the target Windows server for deletion are the same.
</Callout>
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Administrator &gt; Servers &gt; Server Access Control &gt; Access Control
1. Navigate to Administrator &gt; Servers &gt; Server Access Control &gt; Access Control menu.
2. Select the user or user group to grant permissions to.

#### 2.<Badge color="blue">Step 1</Badge>: Select the account of the server or server group to grant permissions.
#### 2. <Badge color="blue">Step 1</Badge>: Select the account of the server or server group to grant permissions.

<figure data-layout="center" data-align="center">
<img src="/administrator-manual/servers/server-access-control/access-control/granting-and-revoking-permissions/image-20240828-015324.png" alt="Administrator &gt; Servers &gt; Server Access Control &gt; Access Control &gt; Details &gt; Grant Permissions Step 1" width="760" />
Expand All @@ -47,7 +47,7 @@ In Grant Permissions Step 1, a maximum of 1000 servers are displayed.
If more than 1000 servers are registered in a single server group, add servers through server name search in the Servers field.
</Callout>

#### 3.<Badge color="blue">Step 2</Badge>: Set access policies for the selected servers.
#### 3. <Badge color="blue">Step 2</Badge>: Set access policies for the selected servers.

<figure data-layout="center" data-align="center">
<img src="/administrator-manual/servers/server-access-control/access-control/granting-and-revoking-permissions/Screenshot-2025-07-27-at-5.28.54-PM.png" alt="Administrator &gt; Servers &gt; Server Access Control &gt; Access Control &gt; Details &gt; Grant Permissions Step 2" width="760" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -148,14 +148,14 @@ Detailed conditions for rule application targets

Below is the QueryPie WAC Policy YAML syntax needed for policy writing.

### spec: &lt;effect&gt;<Badge color="red">required</Badge>
### spec: &lt;effect&gt; <Badge color="red">required</Badge>

Specifies whether to allow or deny specific rules of the policy. Supports `spec: allow` or `spec: deny`.

1. A policy can have a maximum of 1 `allow` and 1 `deny`.
2. When `deny` and `allow` are declared simultaneously for the same element within a policy, `deny` takes precedence.

### Resources<Badge color="red">required</Badge>
### Resources <Badge color="red">required</Badge>

Specifies the web app resources for which you want to set allow or block policies.
Must have `webApp` and `urlPaths` as sub-elements.
Expand All @@ -164,7 +164,7 @@ Must have `webApp` and `urlPaths` as sub-elements.
`resources` is allowed in both `spec: allow` and `spec: deny`.
</Callout>

#### webApp<Badge color="red">required</Badge>
#### webApp <Badge color="red">required</Badge>

Enter the web app resource name defined in QueryPie.

Expand All @@ -190,7 +190,7 @@ spec:
* Start and end are limited to alphabetic case-sensitive letters or numbers
* No duplicates allowed

#### urlPaths<Badge color="green">OPTIONAL</Badge>
#### urlPaths <Badge color="green">OPTIONAL</Badge>

Specifies the sub-paths of specific web app resources to which you want to apply policies.

Expand Down Expand Up @@ -247,15 +247,15 @@ An error occurs when entering unregistered sub-paths.
* `"^/database-settings/policies/data-.*$"` (X)
2. When deny and allow policies overlap for the same resource (and sub-paths), **deny policies take precedence**.

### Conditions<Badge color="green">OPTIONAL</Badge>
### Conditions <Badge color="green">OPTIONAL</Badge>

`conditions` defines conditions to narrow the scope of resources to which rules apply. Three types of condition specifications are possible: `urlPathTags`, `userAttributes`, and `ipAddresses`.

<Callout type="info">
`conditions` is only syntactically allowed in spec:allow.
</Callout>

#### urlPathTags<Badge color="green">OPTIONAL</Badge>
#### urlPathTags <Badge color="green">OPTIONAL</Badge>

Limits the scope of resources whose access is allowed by rules based on tags assigned to Web App's Path Management.

Expand Down Expand Up @@ -306,7 +306,7 @@ spec:
* **When target urlPath of web app resource is specified but no matching urlPathTag exists within the scope**
* No paths match the conditions, so no paths are allowed.

#### userAttributes<Badge color="green">OPTIONAL</Badge>
#### userAttributes <Badge color="green">OPTIONAL</Badge>

Limits the scope of users whose resource access is allowed by rules based on QueryPie user attributes.

Expand All @@ -332,7 +332,7 @@ userAttributes:
"title": "Manager"
```

#### ipAddresses<Badge color="green">OPTIONAL</Badge>
#### ipAddresses <Badge color="green">OPTIONAL</Badge>

Defines a list of IP access control conditions for resources in single IP, CIDR format.
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -178,14 +178,14 @@ Detailed conditions for rule application targets

Below is the QueryPie WAC Policy YAML syntax needed for policy writing.

### spec: &lt;effect&gt;<Badge color="red">required</Badge>
### spec: &lt;effect&gt; <Badge color="red">required</Badge>

Specifies whether to allow or deny specific rules of the policy. Supports `spec: allow` or `spec: deny`.

1. A policy can have a maximum of 1 `allow` and 1 `deny`.
2. When `deny` and `allow` are declared simultaneously for the same element within a policy, `deny` takes precedence.

### Resources<Badge color="red">required</Badge>
### Resources <Badge color="red">required</Badge>

Specifies the web app resources for which you want to set allow or block policies.
Must have `webApp` as a required sub-element and can have `urlPaths` or `urlPathTags`.
Expand All @@ -195,7 +195,7 @@ Must have `webApp` as a required sub-element and can have `urlPaths` or `urlPath
However, specification through `urlPathTags` is only supported in `spec: allow`.
</Callout>

#### webApp<Badge color="red">required</Badge>
#### webApp <Badge color="red">required</Badge>

Enter the web app resource name defined in QueryPie.

Expand Down Expand Up @@ -226,7 +226,7 @@ spec:
To operate access control policies at the sub-path level of web apps, you can enter `urlPaths` or `urlPathTags` under `webApp`.
Within one policy, it is **impossible** to specify both `urlPaths` and `urlPathTags` for the same web app.

#### urlPaths<Badge color="green">OPTIONAL</Badge>
#### urlPaths <Badge color="green">OPTIONAL</Badge>

Specifies the sub-paths of specific web app resources to which you want to apply policies.

Expand Down Expand Up @@ -269,7 +269,7 @@ spec:
* `"^/database-settings/policies/data-.*$"` (X)
5. When deny and allow policies overlap for the same resource (and sub-paths), **deny policies are applied first**.

#### urlPathTags<Badge color="green">OPTIONAL</Badge>
#### urlPathTags <Badge color="green">OPTIONAL</Badge>

Specifies sub-paths to allow access based on URL Path tags assigned to each sub-path registered in the web app.

Expand All @@ -289,15 +289,15 @@ urlPathTags:
"type": "general"
```

### Conditions<Badge color="green">OPTIONAL</Badge>
### Conditions <Badge color="green">OPTIONAL</Badge>

`conditions` defines conditions to narrow the scope of resources to which rules apply. Two types of condition specifications are possible: `userAttributes` and `ipAddresses`.

<Callout type="info">
`conditions` is only syntactically allowed in spec:allow.
</Callout>

#### userAttributes<Badge color="green">OPTIONAL</Badge>
#### userAttributes <Badge color="green">OPTIONAL</Badge>

Limits the scope of users whose resource access is allowed by rules based on QueryPie user attributes.

Expand All @@ -323,7 +323,7 @@ userAttributes:
"title": "Manager"
```

#### ipAddresses<Badge color="green">OPTIONAL</Badge>
#### ipAddresses <Badge color="green">OPTIONAL</Badge>

Defines a list of IP access control conditions for resources in single IP, CIDR format.
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Admin &gt; Web Apps &gt; Connection Management &gt; Web App Configurations
</figcaption>
</figure>

### WAC Proxy Configurations<Badge color="grey">10.2.6~</Badge>
### WAC Proxy Configurations <Badge color="grey">10.2.6~</Badge>

After configuring the WAC proxy server, enter the server configuration information.
The description of each field is as follows.
Expand All @@ -39,7 +39,7 @@ The description of each field is as follows.
3. Use the following command to restart the container: `docker compose up -d`
</Callout>

### QueryPie Web Secure (Extension) Configurations<Badge color="grey">10.2.6~</Badge>
### QueryPie Web Secure (Extension) Configurations <Badge color="grey">10.2.6~</Badge>

Administrators can directly manage WAC Extension related settings.

Expand Down Expand Up @@ -82,7 +82,7 @@ Current Version and Minimum Required Version information must be entered accordi
3. Update compatibility information changes according to the guide received from QueryPie manufacturer.
4. Click the `Save` button to save.

### Watermark Configurations<Badge color="grey">10.2.6~</Badge>
### Watermark Configurations <Badge color="grey">10.2.6~</Badge>

In the Watermark Configurations section, you can check the currently applied watermark text settings and set the text you want when applying watermarks.

Expand All @@ -99,7 +99,7 @@ In the Watermark Configurations section, you can check the currently applied wat
5. **Timestamp** : The time when the page was first accessed is displayed.
6. **Client IP** : The client IP that accessed the page is displayed.

### Root CA Certificate Configurations<Badge color="grey">10.2.8~</Badge>
### Root CA Certificate Configurations <Badge color="grey">10.2.8~</Badge>

In the Root CA Certificate Configurations section, you can backup and restore the Root CA certificate currently used by QueryPie.

Expand Down
10 changes: 5 additions & 5 deletions src/content/en/installation/license-installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { Callout } from 'nextra/components'

This guide explains how to install and upgrade Product License for QueryPie product.

### When Installing QueryPie for the First Time<Badge color="grey">11.3.0</Badge>
### When Installing QueryPie for the First Time <Badge color="grey">11.3.0</Badge>

When you first install and run QueryPie ACP, accessing the web console through a web browser will prompt you to enter a license.
Once you enter the license correctly, you will see the login screen.
Expand All @@ -21,7 +21,7 @@ PEM format license input screen
</figcaption>
</figure>

### Adding or Replacing a License<Badge color="grey">11.3.0</Badge>
### Adding or Replacing a License <Badge color="grey">11.3.0</Badge>

In version 11.3.0 or later, you can install, add, or replace product licenses through the web console: [Licenses](../administrator-manual/general/company-management/licenses)

Expand All @@ -35,7 +35,7 @@ The status of valid licenses is categorized as follows based on activation statu
* Activated: Currently activated state
* Available: A usable license that has not been activated

### When Installing QueryPie for the First Time<Badge color="grey">Deprecated</Badge>
### When Installing QueryPie for the First Time <Badge color="grey">Deprecated</Badge>

When installing QueryPie for the first time, you can install Product License by running a component called QueryPie Tools.
QueryPie Tools is a tool that operates separately from QueryPie Server and is used for product installation, upgrade, license installation, etc.
Expand All @@ -62,7 +62,7 @@ If you see the response message `[License] Upload: Success`, the license has bee

For detailed explanations of the overall product installation process and Product License installation steps, please refer to the following document: [Installation Guide - Simple Configuration](installation/installation-guide-simple-configuration)

### When Extending License for QueryPie in Use<Badge color="grey">Deprecated</Badge>
### When Extending License for QueryPie in Use <Badge color="grey">Deprecated</Badge>

There may be cases where you want to extend the license for QueryPie currently in use.
For example, assume a case where you want to install a Production License on a QueryPie Server Instance that was running PoC and extend the existing PoC License.
Expand Down Expand Up @@ -98,7 +98,7 @@ However, in some cases, you may encounter the response message `[License] Upload
If you encounter this response message, please refer to the "When Replacing License for QueryPie in Use" section for how to handle it.


### When Replacing License for QueryPie in Use<Badge color="grey">Deprecated</Badge>
### When Replacing License for QueryPie in Use <Badge color="grey">Deprecated</Badge>

QueryPie's License management functionality has one constraint: if the validity period of the existing license partially overlaps with the validity period of the new license, you cannot install the new license additionally.
Due to this, when installing a license with an overlapping validity period, you must delete the existing license through a separate procedure and then install the new license.
Expand Down
10 changes: 5 additions & 5 deletions src/content/en/user-manual.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,11 @@ Click on each item to see detailed usage instructions.
* [Requesting DB Access](user-manual/workflow/requesting-db-access)
* [Requesting SQL](user-manual/workflow/requesting-sql)
* [Requesting SQL Export](user-manual/workflow/requesting-sql-export)
* [Requesting Unmasking](user-manual/workflow/requesting-unmasking-mask-removal-request)
* [Requesting Unmasking (Mask Removal Request)](user-manual/workflow/requesting-unmasking-mask-removal-request)
* [Requesting Restricted Data Access](user-manual/workflow/requesting-restricted-data-access)
* [Requesting Server Access](user-manual/workflow/requesting-access-role)
* [Requesting Server Privilege](user-manual/workflow/requesting-server-privilege)
* [Requesting Access Role](user-manual/workflow/requesting-access-role)
* [Requesting Server Access](user-manual/workflow/requesting-server-access)
* [Requesting Server Privilege](user-manual/workflow/requesting-server-privilege) - Request temporary command usage permissions for servers
* [Requesting Access Role](user-manual/workflow/requesting-access-role) - Request roles to access servers or Kubernetes clusters
* [Requesting IP Registration](user-manual/workflow/requesting-ip-registration)
* [Requesting DB Policy Exception](user-manual/workflow/requesting-db-policy-exception)
</td>
Expand Down Expand Up @@ -105,7 +105,7 @@ Click on each item to see detailed usage instructions.
**Access with QueryPie Agent**
</th>
<td>
* [Agent](user-manual/multi-agent)
* [Multi Agent](user-manual/multi-agent)
</td>
</tr>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion src/content/en/user-manual/multi-agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ Multi-Agent &gt; Setting &gt; Kubernetes
</figcaption>
</figure>

### SAC<Badge color="grey">10.2.8~</Badge>
### SAC <Badge color="grey">10.2.8~</Badge>

#### Connecting to Server with Agent

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ $ qpctl host use nightly.dev.querypie.io
[qpctl-host-use-with-hostname.mov](/user-manual/multi-agent/multi-agent-seamless-ssh-usage-guide/qpctl-host-use-with-hostname.mov)
</figure>

#### ⚠️ Experimental feature - Use qpctl directly ⚠️
#### ⚠️ Experimental feature - Use qpctl directly ⚠️

To use Seamless SSH

Expand Down
Loading