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
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,7 @@ Okta details (1)

* **Name** : Enter a suitable name for the IdP for easy identification.
* **Type** : Select Okta.
* **Identity Provider Metadata** : <br/>Paste the XML information copied in the process described in [https://querypie.atlassian.net/wiki/spaces/QM/pages/edit-v2/1454342158#Okta%EC%97%90%EC%84%9C-QueryPie-%EC%95%A0%ED%94%8C%EB%A6%AC%EC%BC%80%EC%9D%B4%EC%85%98-%EC%97%B0%EB%8F%99-%EC%A0%95%EB%B3%B4-%EC%84%A4%EC%A0%95](https://querypie.atlassian.net/wiki/spaces/QM/pages/edit-v2/1454342158#Okta%EC%97%90%EC%84%9C-QueryPie-%EC%95%A0%ED%94%8C%EB%A6%AC%EC%BC%80%EC%9D%B4%EC%85%98-%EC%97%B0%EB%8F%99-%EC%A0%95%EB%B3%B4-%EC%84%A4%EC%A0%95) into the Identity Provider Metadata field.
* **Identity Provider Metadata** : <br/>Paste the XML information copied in the process described in [https://querypie.atlassian.net/wiki/spaces/QM/pages/1454342158/Identity+Providers#Okta%EC%97%90%EC%84%9C-QueryPie-%EC%95%A0%ED%94%8C%EB%A6%AC%EC%BC%80%EC%9D%B4%EC%85%98-%EC%97%B0%EB%8F%99-%EC%A0%95%EB%B3%B4-%EC%84%A4%EC%A0%95](https://querypie.atlassian.net/wiki/spaces/QM/pages/1454342158/Identity+Providers#Okta%EC%97%90%EC%84%9C-QueryPie-%EC%95%A0%ED%94%8C%EB%A6%AC%EC%BC%80%EC%9D%B4%EC%85%98-%EC%97%B0%EB%8F%99-%EC%A0%95%EB%B3%B4-%EC%84%A4%EC%A0%95) into the Identity Provider Metadata field.
* **Use SAML Assertion Consumer Service Index** : When the Service Provider uses multiple Endpoints, you can use the ACS Index to specify each endpoint.
* Entity ID : Enter in the format `https://your-domain.com/saml/sp/metadata`. This is the Audience URI (SP Entity ID) value in Okta SAML 2.0 settings.
* ACS Index : Enter a value between 0 and 2,147,483,647 (default is 0).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Even with a simple configuration installation, you can test most QueryPie featur

The setup.v2.sh installation program introduced in this guide automatically performs the existing installation process.
The automated installation process is largely the same as the existing installation process.
For the existing installation process, please refer to this document: [https://querypie.atlassian.net/wiki/spaces/QM/pages/964952065/-?atl_f=PAGETREE](https://querypie.atlassian.net/wiki/spaces/QM/pages/964952065/-?atl_f=PAGETREE)
For the existing installation process, please refer to this document: [Installation Guide - Simple Configuration](installation-guide-simple-configuration)

This installation method is not suitable for use in actual production environments.
For installation methods suitable for actual production environments, please refer to the separately provided [QueryPie Installation Guide].
Expand All @@ -31,7 +31,7 @@ In summary, they are as follows.
* 1 Linux server
* 1 PC with a web browser installed

For details, please refer to the following document: [Prerequisites - Simple Configuration](../prerequisites)
For details, please refer to the following document: [Prerequisites](../prerequisites)

## System Architecture

Expand Down Expand Up @@ -94,6 +94,7 @@ OPTIONS:
$
```


### Installing QueryPie in Podman Environment

Starting from `setup.v2.sh` version `25.08.8`, it supports execution environments with Podman + Docker Compose combination.
Expand Down Expand Up @@ -153,6 +154,7 @@ After `setup.v2.sh` successfully starts the querypie-app container, you will see
[ec2-user@ip-172-31-11-201 ~]$
```


### Installation Complete

Great job.
Expand All @@ -173,6 +175,7 @@ Enter the license in PEM format.
</figcaption>
</figure>


## Basic Configuration Procedures

This guide explains settings that must be performed after installation according to the operating environment.
Expand All @@ -194,6 +197,7 @@ This URL is used for the following purposes.
* Used in links to download User Agent from Web Console.
* For other detailed purposes, please refer to [https://chequer.atlassian.net/wiki/spaces/QCP/pages/876937310](https://chequer.atlassian.net/wiki/spaces/QCP/pages/876937310).


<figure data-layout="center" data-align="center">
![image-20250520-081112.png](/installation/installation/installation-guide-setupv2sh/image-20250520-081112.png)
</figure>
Expand Down Expand Up @@ -257,6 +261,7 @@ UPDATE querypie.k_proxy_setting SET host = 'https://<customer-proxy-fqdn>';
![image-20250520-084243.png](/installation/installation/installation-guide-setupv2sh/image-20250520-084243.png)
</figure>


#### WAC: Proxy Access Address Settings

> Configuration path: Admin Page → Web Apps → Web App Configurations
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Linux distributions that install Podman are as follows.
* Ubuntu 24.04 LTS

Linux distributions that install Docker instead of Podman are as follows.
For reasons why Docker should be used in the Linux distributions below, please refer to this document: [https://querypie.atlassian.net/wiki/spaces/QCP/pages/1298530305/Docker+Podman+and+Linux+Distributions+KO?atl_f=PAGETREE](https://querypie.atlassian.net/wiki/spaces/QCP/pages/1298530305/Docker+Podman+and+Linux+Distributions+KO?atl_f=PAGETREE)
For reasons why Docker should be used in the Linux distributions below, please refer to this document: [Linux Distribution and Docker, Podman Support Status](linux-distribution-and-docker-podman-support-status)

* Amazon Linux 2, Amazon Linux 2023
* Ubuntu 22.04 LTS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ title: 'Server Configuration Requirements'
# Server Configuration Requirements

This guide provides information on hardware performance and processing capacity for servers to install and operate QueryPie.
* [https://querypie.atlassian.net/wiki/spaces/QM/pages/903086124/Public+Cloud?atl_f=PAGETREE](https://querypie.atlassian.net/wiki/spaces/QM/pages/903086124/Public+Cloud?atl_f=PAGETREE)
* [Public Cloud Production Server Requirements](server-configuration-requirements/public-cloud-production-server-requirements)
* [On-Premise VM Requirements](server-configuration-requirements/on-premise-vm-requirements)
* [Server Configuration Requirements Summary Table](server-configuration-requirements/server-configuration-requirements-summary)
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,7 @@ Okta詳細設定(1)

* **Name** : 識別に便利な適切なIdPの名前を入力します。
* **Type** : Oktaを選択します。
* **Identity Provider Metadata** : <br/>[https://querypie.atlassian.net/wiki/spaces/QM/pages/edit-v2/1454342158#Okta%EC%97%90%EC%84%9C-QueryPie-%EC%95%A0%ED%94%8C%EB%A6%AC%EC%BC%80%EC%9D%B4%EC%85%98-%EC%97%B0%EB%8F%99-%EC%A0%95%EB%B3%B4-%EC%84%A4%EC%A0%95](https://querypie.atlassian.net/wiki/spaces/QM/pages/edit-v2/1454342158#Okta%EC%97%90%EC%84%9C-QueryPie-%EC%95%A0%ED%94%8C%EB%A6%AC%EC%BC%80%EC%9D%B4%EC%85%98-%EC%97%B0%EB%8F%99-%EC%A0%95%EB%B3%B4-%EC%84%A4%EC%A0%95)過程でコピーしたXML情報をIdentity Provider Metadata項目に貼り付けます。
* **Identity Provider Metadata** : <br/>[https://querypie.atlassian.net/wiki/spaces/QM/pages/1454342158/Identity+Providers#Okta%EC%97%90%EC%84%9C-QueryPie-%EC%95%A0%ED%94%8C%EB%A6%AC%EC%BC%80%EC%9D%B4%EC%85%98-%EC%97%B0%EB%8F%99-%EC%A0%95%EB%B3%B4-%EC%84%A4%EC%A0%95](https://querypie.atlassian.net/wiki/spaces/QM/pages/1454342158/Identity+Providers#Okta%EC%97%90%EC%84%9C-QueryPie-%EC%95%A0%ED%94%8C%EB%A6%AC%EC%BC%80%EC%9D%B4%EC%85%98-%EC%97%B0%EB%8F%99-%EC%A0%95%EB%B3%B4-%EC%84%A4%EC%A0%95)過程でコピーしたXML情報をIdentity Provider Metadata項目に貼り付けます。
* **Use SAML Assertion Consumer Service Index** : Service Providerで複数のEndpointを使用する場合、ACS Indexを使用してendpointをそれぞれ指定できます。
* Entity ID:`https://your-domain.com/saml/sp/metadata`の形式で入力します。Okta SAML 2.0設定のAudience URI(SP Entity ID)値です。
* ACS Index:0~2,147,483,647の間の値を入力します。基本値は0です。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import { Callout } from 'nextra/components'

このガイドで案内するsetup.v2.shインストールプログラムは既存のインストール過程を自動的に実行します。
自動化されたインストール過程は既存のインストール過程と主要部分が同一です。
既存インストール過程はこの文書を参照してください:[https://querypie.atlassian.net/wiki/spaces/QM/pages/964952065/-?atl_f=PAGETREE](https://querypie.atlassian.net/wiki/spaces/QM/pages/964952065/-?atl_f=PAGETREE)
既存インストール過程はこの文書を参照してください:[インストールガイド - 簡単な構成](installation-guide-simple-configuration)

このインストール方式は実際の運用環境で使用するには適していません。
実際の運用環境で使用するのに適したインストール方法は別途提供される[QueryPie Installation Guide]を参照してください。
Expand All @@ -31,7 +31,7 @@ QueryPie 10.3.0以降のバージョンを対象とするPoC用途のインス
* Linuxサーバ1台
* ウェブブラウザがインストールされたPC 1台

詳細は次の文書を参照してください:[インストール前の準備事項 - 簡単な構成](../prerequisites)
詳細は次の文書を参照してください:[インストール前の準備事項](../prerequisites)

## システムアーキテクチャ

Expand Down Expand Up @@ -94,6 +94,7 @@ OPTIONS:
$
```


### Podman環境でQueryPieインストール

`setup.v2.sh` `25.08.8`バージョンからはPodman + Docker Compose組み合わせの実行環境をサポートします。
Expand All @@ -112,7 +113,7 @@ $
1. `docker-compose.yml`、`.env`などComposeのための設定ファイルをダウンロード
* 既存の`compose-env`という環境変数設定ファイルの名前が`.env`に変わりました。`compose-env`は設定ファイル生成のためのtemplateとして使用されます。
2. `.env`に環境変数値を設定
* 各環境変数に関する説明は[コンテナ環境変数案内](../container-environment-variables)文書を参照してください。
* 各環境変数に関する説明は[コンテナ環境変数](../container-environment-variables)文書を参照してください。
3. docker imageダウンロード
* `docker.io/querypie/` registryからimageをダウンロードします。したがって、Harbor login過程は必要ありません。
4. mysql、redis container実行
Expand Down Expand Up @@ -153,6 +154,7 @@ $
[ec2-user@ip-172-31-11-201 ~]$
```


### インストール完了

お疲れさまでした。
Expand All @@ -173,6 +175,7 @@ Enter the license in PEM format.
</figcaption>
</figure>


## 基本設定手順

運用環境に従ってインストール以降必須的に実行が必要な設定を案内します。
Expand All @@ -194,6 +197,7 @@ Web ConsoleにアクセスするためのQueryPieのURLアドレスです。<br/
* Web ConsoleでUser Agentをダウンロードするリンクに使用されます。
* その他詳細な用途は、[https://chequer.atlassian.net/wiki/spaces/QCP/pages/876937310](https://chequer.atlassian.net/wiki/spaces/QCP/pages/876937310)を参照してください。


<figure data-layout="center" data-align="center">
![image-20250520-081112.png](/installation/installation/installation-guide-setupv2sh/image-20250520-081112.png)
</figure>
Expand Down Expand Up @@ -257,6 +261,7 @@ UPDATE querypie.k_proxy_setting SET host = 'https://<customer-proxy-fqdn>';
![image-20250520-084243.png](/installation/installation/installation-guide-setupv2sh/image-20250520-084243.png)
</figure>


#### WAC: Proxy接続アドレス設定

> 設定経路:Admin Page → Web Apps → Web App Configurations
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ PodmanをインストールしてくれるLinuxディストリビューション
* Ubuntu 24.04 LTS

Podmanをインストールせず、DockerをインストールしてくれるLinuxディストリビューションは以下のとおりです。
以下のLinuxディストリビューションでDockerを使用しなければならない理由についてはこの文書を参照してください:[https://querypie.atlassian.net/wiki/spaces/QCP/pages/1298530305/Docker+Podman+and+Linux+Distributions+KO?atl_f=PAGETREE](https://querypie.atlassian.net/wiki/spaces/QCP/pages/1298530305/Docker+Podman+and+Linux+Distributions+KO?atl_f=PAGETREE)
以下のLinuxディストリビューションでDockerを使用しなければならない理由についてはこの文書を参照してください:[LinuxディストリビューションとDocker、Podmanサポート状況](linux-distribution-and-docker-podman-support-status)

* Amazon Linux 2、Amazon Linux 2023
* Ubuntu 22.04 LTS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ title: 'サーバ構成要件'
# サーバ構成要件

QueryPieをインストール、運用するためのサーバのハードウェア性能と処理容量に関するガイドを提供します。
* [https://querypie.atlassian.net/wiki/spaces/QM/pages/903086124/Public+Cloud?atl_f=PAGETREE](https://querypie.atlassian.net/wiki/spaces/QM/pages/903086124/Public+Cloud?atl_f=PAGETREE)
* [Public Cloud本番サーバ要件](server-configuration-requirements/public-cloud-production-server-requirements)
* [On-Premise VM要件](server-configuration-requirements/on-premise-vm-requirements)
* [サーバ構成要件要約表](server-configuration-requirements/server-configuration-requirements-summary)
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,7 @@ Okta 상세설정 (1)

* **Name** : 식별에 용이하도록 적합한 IdP의 이름을 입력합니다.
* **Type** : Okta를 선택합니다.
* **Identity Provider Metadata** : <br/>[https://querypie.atlassian.net/wiki/spaces/QM/pages/edit-v2/1454342158#Okta%EC%97%90%EC%84%9C-QueryPie-%EC%95%A0%ED%94%8C%EB%A6%AC%EC%BC%80%EC%9D%B4%EC%85%98-%EC%97%B0%EB%8F%99-%EC%A0%95%EB%B3%B4-%EC%84%A4%EC%A0%95](https://querypie.atlassian.net/wiki/spaces/QM/pages/edit-v2/1454342158#Okta%EC%97%90%EC%84%9C-QueryPie-%EC%95%A0%ED%94%8C%EB%A6%AC%EC%BC%80%EC%9D%B4%EC%85%98-%EC%97%B0%EB%8F%99-%EC%A0%95%EB%B3%B4-%EC%84%A4%EC%A0%95) 과정에서 복사한 XML 정보를 Identity Provider Metadata 항목에 붙여넣기합니다.
* **Identity Provider Metadata** : <br/>[https://querypie.atlassian.net/wiki/spaces/QM/pages/1454342158/Identity+Providers#Okta%EC%97%90%EC%84%9C-QueryPie-%EC%95%A0%ED%94%8C%EB%A6%AC%EC%BC%80%EC%9D%B4%EC%85%98-%EC%97%B0%EB%8F%99-%EC%A0%95%EB%B3%B4-%EC%84%A4%EC%A0%95](https://querypie.atlassian.net/wiki/spaces/QM/pages/1454342158/Identity+Providers#Okta%EC%97%90%EC%84%9C-QueryPie-%EC%95%A0%ED%94%8C%EB%A6%AC%EC%BC%80%EC%9D%B4%EC%85%98-%EC%97%B0%EB%8F%99-%EC%A0%95%EB%B3%B4-%EC%84%A4%EC%A0%95) 과정에서 복사한 XML 정보를 Identity Provider Metadata 항목에 붙여넣기합니다.
* **Use SAML Assertion Consumer Service Index** : Service Provider에서 여러개의 Endpoint 를 사용하는 경우 ACS Index를 사용하여 endpoint를 각각 지정할 수 있습니다.
* Entity ID : `https://your-domain.com/saml/sp/metadata` 의 형식으로 입력합니다. Okta SAML 2.0 설정의 Audience URI (SP Entity ID) 값입니다.
* ACS Index : 0 ~ 2,147,483,647 사이의 값을 입력합니다. 기본값은 0 입니다.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import { Callout } from 'nextra/components'

이 가이드에서 안내하는 setup.v2.sh 설치 프로그램은 기존의 설치 과정을 자동으로 수행합니다.
자동화된 설치 과정은 기존의 설치 과정과 주요 부분이 동일합니다.
기존 설치 과정은 이 문서를 참조하세요: [https://querypie.atlassian.net/wiki/spaces/QM/pages/964952065/-?atl_f=PAGETREE](https://querypie.atlassian.net/wiki/spaces/QM/pages/964952065/-?atl_f=PAGETREE)
기존 설치 과정은 이 문서를 참조하세요: [설치 가이드 - 간단한 구성](installation-guide-simple-configuration)

이 설치 방식은 실제 운영 환경에서 사용하기에는 적합하지 않습니다.
실제 운영 환경에 사용하기에 적합한 설치 방법은 별도로 제공되는 [QueryPie Installation Guide]를 참고하십시오.
Expand All @@ -31,7 +31,7 @@ QueryPie 10.3.0 또는 이후 버전을 대상으로 하는 PoC 용도의 설치
* Linux 서버 1대
* 웹 브라우저가 설치된 PC 1대

자세한 것은 다음 문서를 참조하세요: [설치 전 준비사항 - 간단한 구성](../prerequisites)
자세한 것은 다음 문서를 참조하세요: [설치 전 준비사항](../prerequisites)

## 시스템 아키텍처

Expand Down Expand Up @@ -94,6 +94,7 @@ OPTIONS:
$
```


### Podman 환경에서 QueryPie 설치하기

`setup.v2.sh` `25.08.8` 버전부터는 Podman + Docker Compose 조합의 실행환경을 지원합니다.
Expand All @@ -112,7 +113,7 @@ $
1. `docker-compose.yml` , `.env` 등 Compose 를 위한 설정파일을 내려 받기
* 기존의 `compose-env` 라는 환경변수 설정 파일의 이름이 `.env` 로 바뀌었습니다. `compose-env` 는 설정파일 생성을 위한 template 으로 사용됩니다.
2. `.env` 에 환경변수 값을 설정하기
* 각 환경변수에 대한 설명은 [컨테이너 환경변수 안내](../container-environment-variables) 문서를 참고해주세요.
* 각 환경변수에 대한 설명은 [컨테이너 환경변수](../container-environment-variables) 문서를 참고해주세요.
3. docker image 내려받기
* `docker.io/querypie/` registry 에서 image 를 내려받습니다. 따라서, Harbor login 과정이 필요하지 않습니다.
4. mysql, redis container 실행하기
Expand Down Expand Up @@ -153,6 +154,7 @@ $
[ec2-user@ip-172-31-11-201 ~]$
```


### 설치 완료

수고하셨습니다.
Expand All @@ -173,6 +175,7 @@ Enter the license in PEM format.
</figcaption>
</figure>


## 기본 설정 절차

운영 환경에 따라 설치 이후 필수적으로 수행이 필요한 설정들을 안내합니다.
Expand All @@ -194,6 +197,7 @@ Web Console 에 접근하기 위한 QueryPie 의 URL 주소입니다. <br/>(예
* Web Console 에서 User Agent 를 내려받는 링크에 사용됩니다.
* 그 외 자세한 용도는, [https://chequer.atlassian.net/wiki/spaces/QCP/pages/876937310](https://chequer.atlassian.net/wiki/spaces/QCP/pages/876937310) 를 참조하시기 바랍니다.


<figure data-layout="center" data-align="center">
![image-20250520-081112.png](/installation/installation/installation-guide-setupv2sh/image-20250520-081112.png)
</figure>
Expand Down Expand Up @@ -257,6 +261,7 @@ UPDATE querypie.k_proxy_setting SET host = 'https://<customer-proxy-fqdn>';
![image-20250520-084243.png](/installation/installation/installation-guide-setupv2sh/image-20250520-084243.png)
</figure>


#### WAC: Proxy 접속 주소 설정

> 설정 경로: Admin Page → Web Apps → Web App Configurations
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Podman 을 설치하여 주는 리눅스 배포본은 다음과 같습니다.
* Ubuntu 24.04 LTS

Podman 을 설치하지 않고, Docker 를 설치하여 주는 리눅스 배포본은 다음과 같습니다.
아래의 리눅스 배포판에서 Docker 를 사용하여야 하는 이유에 대해서는 이 문서를 참조하세요: [https://querypie.atlassian.net/wiki/spaces/QCP/pages/1298530305/Docker+Podman+and+Linux+Distributions+KO?atl_f=PAGETREE](https://querypie.atlassian.net/wiki/spaces/QCP/pages/1298530305/Docker+Podman+and+Linux+Distributions+KO?atl_f=PAGETREE)
아래의 리눅스 배포판에서 Docker 를 사용하여야 하는 이유에 대해서는 이 문서를 참조하세요: [리눅스 배포본과 Docker, Podman 지원 현황](linux-distribution-and-docker-podman-support-status)

* Amazon Linux 2, Amazon Linux 2023
* Ubuntu 22.04 LTS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ title: '서버구성 요구사항'
# 서버구성 요구사항

QueryPie 를 설치, 운영하기 위한 서버의 하드웨어 성능과 처리용량에 대한 가이드를 제공합니다.
* [https://querypie.atlassian.net/wiki/spaces/QM/pages/903086124/Public+Cloud?atl_f=PAGETREE](https://querypie.atlassian.net/wiki/spaces/QM/pages/903086124/Public+Cloud?atl_f=PAGETREE)
* [Public Cloud 운영서버 요구사항](server-configuration-requirements/public-cloud-production-server-requirements)
* [On-Premise VM 요구사항](server-configuration-requirements/on-premise-vm-requirements)
* [서버구성 요구사항 요약표](server-configuration-requirements/server-configuration-requirements-summary)