Skip to content

Commit e7a4b9f

Browse files
github-actions[bot]josh-wong
github-actions[bot]
and
josh-wong
authored
AUTO: Sync components to docs site repo (#861)
Co-authored-by: josh-wong <[email protected]>
1 parent 3da04e6 commit e7a4b9f

File tree

2 files changed

+44
-46
lines changed

2 files changed

+44
-46
lines changed

‎src/components/en-us/_getting-started-db-specific-steps.mdx‎

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ If you're using the ScalarDL Enterprise edition, set up your license as follows.
77
<details>
88
<summary>See here to set up your license</summary>
99

10-
1. Enable the Docker image for the Enterprise edition in the <code>docker-compose-ledger-{props.shortName}.yml</code> file as follows:
10+
1. Enable the Docker image for the Enterprise edition in the <code>{props.shortName}/docker-compose-ledger.yml</code> file as follows:
1111

1212
- Before changing the image (default configuration):
1313

1414
```yaml
1515
services:
16-
scalar-ledger:
16+
scalardl-ledger:
1717
image: ghcr.io/scalar-labs/scalardl-ledger:${SCALARDL_VERSION}
1818
# image: ghcr.io/scalar-labs/scalardl-ledger-byol:${SCALARDL_VERSION}
1919
```
@@ -22,46 +22,45 @@ If you're using the ScalarDL Enterprise edition, set up your license as follows.
2222

2323
```yaml
2424
services:
25-
scalar-ledger:
25+
scalardl-ledger:
2626
# image: ghcr.io/scalar-labs/scalardl-ledger:${SCALARDL_VERSION}
2727
image: ghcr.io/scalar-labs/scalardl-ledger-byol:${SCALARDL_VERSION}
2828
```
2929
30-
2. Set your license key for ScalarDL Ledger. In the <code>docker-compose-ledger-{props.shortName}.yml</code> file, replace `<SET_YOUR_LICENSE_KEY>` with your license key. For example:
30+
2. Set your license key for ScalarDL Ledger. In the <code>{props.shortName}/ledger.properties</code> file, replace `<SET_YOUR_LICENSE_KEY>` with your license key. For example:
3131

32-
```yaml
33-
services:
34-
scalar-ledger:
35-
environment:
36-
- SCALAR_DL_LICENSING_LICENSE_KEY={"organization_name":"XXXXXXXX","expiration_date_time":"YYYY-MM-DDTHH:mm:SS+TIMEZONE","product_name":"ScalarDL Ledger","product_version":N,"license_type":"trial","signature":"XXXXXXXX"}
32+
```properties
33+
##### PLEASE REPLACE THIS VALUE WITH YOUR LICENSE KEY (ENTERPRISE EDITION ONLY) #####
34+
scalar.dl.licensing.license_key={"organization_name":"XXXXXXXX","expiration_date_time":"YYYY-MM-DDTHH:mm:SS+TIMEZONE","product_name":"ScalarDL Ledger","product_version":N,"license_type":"trial","signature":"XXXXXXXX"}
35+
##### PLEASE REPLACE THIS VALUE WITH YOUR LICENSE KEY (ENTERPRISE EDITION ONLY) #####
3736
```
3837

39-
3. To check the license, update the <code>docker-compose-ledger-{props.shortName}.yml</code> file as follows. If you're using a trial license, skip this step.
38+
3. To check the license, update the <code>{props.shortName}/docker-compose-ledger.yml</code> file as follows. If you're using a trial license, skip this step.
4039

4140
- Before changing the certificate file path (default configuration):
4241

4342
```yaml
4443
services:
45-
scalar-ledger:
44+
scalardl-ledger:
4645
volumes:
47-
- ./fixture/ledger-key.pem:/scalar/ledger-key.pem
48-
- ./fixture/ledger.properties.tmpl:/scalar/ledger/ledger.properties.tmpl
49-
- ./fixture/trial-license-cert.pem:/scalar/license-cert.pem
46+
- ./ledger.properties:/scalar/ledger/ledger.properties.tmpl
47+
- ../fixture/ledger-key.pem:/scalar/ledger-key.pem
48+
- ../fixture/trial-license-cert.pem:/scalar/license-cert.pem
5049
# If you have a commercial license key, you must use `commercial-license-cert.pem` instead of `trial-license-cert.pem`.
51-
# - ./fixture/commercial-license-cert.pem:/scalar/license-cert.pem
50+
# - ../fixture/commercial-license-cert.pem:/scalar/license-cert.pem
5251
```
5352

5453
- After changing the certificate file path:
5554

5655
```yaml
5756
services:
58-
scalar-ledger:
57+
scalardl-ledger:
5958
volumes:
60-
- ./fixture/ledger-key.pem:/scalar/ledger-key.pem
61-
- ./fixture/ledger.properties.tmpl:/scalar/ledger/ledger.properties.tmpl
62-
# - ./fixture/trial-license-cert.pem:/scalar/license-cert.pem
59+
- ./ledger.properties:/scalar/ledger/ledger.properties.tmpl
60+
- ../fixture/ledger-key.pem:/scalar/ledger-key.pem
61+
# - ../fixture/trial-license-cert.pem:/scalar/license-cert.pem
6362
# If you have a commercial license key, you must use `commercial-license-cert.pem` instead of `trial-license-cert.pem`.
64-
- ./fixture/commercial-license-cert.pem:/scalar/license-cert.pem
63+
- ../fixture/commercial-license-cert.pem:/scalar/license-cert.pem
6564
```
6665
6766
</details>
@@ -72,12 +71,12 @@ You can start using ScalarDL Ledger by following the steps below:
7271
7372
1. Run {props.productName} locally by running the following command:
7473
75-
<CodeBlock language="console">docker compose -f docker-compose-ledger-{props.shortName}.yml up -d {props.shortName}</CodeBlock>
74+
<CodeBlock language="console">docker compose -f {props.shortName}/docker-compose-ledger.yml up -d {props.shortName}</CodeBlock>
7675
7776
2. Load the database schema for ScalarDL Ledger by running the following command:
7877
79-
<CodeBlock language="console">docker compose -f docker-compose-ledger-{props.shortName}.yml up -d scalardl-ledger-schema-loader</CodeBlock>
78+
<CodeBlock language="console">docker compose -f {props.shortName}/docker-compose-ledger.yml up -d scalardl-ledger-schema-loader</CodeBlock>
8079
8180
3. Run ScalarDL Ledger and its dependent components by running the following command:
8281
83-
<CodeBlock language="console">docker compose -f docker-compose-ledger-{props.shortName}.yml up -d</CodeBlock>
82+
<CodeBlock language="console">docker compose -f {props.shortName}/docker-compose-ledger.yml up -d</CodeBlock>

‎src/components/ja-jp/_getting-started-db-specific-steps.mdx‎

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ ScalarDL Enterprise Edition を使用している場合は、次のようにラ
77
<details>
88
<summary>ライセンスの設定についてはこちらをご覧ください</summary>
99

10-
1. 次のように、<code>docker-compose-ledger-{props.shortName}.yml</code> ファイルで Enterprise Edition の Docker イメージを有効にします。
10+
1. 次のように、<code>{props.shortName}/docker-compose-ledger.yml</code> ファイルで Enterprise Edition の Docker イメージを有効にします。
1111

1212
- イメージを変更する前 (デフォルト設定):
1313

1414
```yaml
1515
services:
16-
scalar-ledger:
16+
scalardl-ledger:
1717
image: ghcr.io/scalar-labs/scalardl-ledger:${SCALARDL_VERSION}
1818
# image: ghcr.io/scalar-labs/scalardl-ledger-byol:${SCALARDL_VERSION}
1919
```
@@ -22,46 +22,45 @@ ScalarDL Enterprise Edition を使用している場合は、次のようにラ
2222

2323
```yaml
2424
services:
25-
scalar-ledger:
25+
scalardl-ledger:
2626
# image: ghcr.io/scalar-labs/scalardl-ledger:${SCALARDL_VERSION}
2727
image: ghcr.io/scalar-labs/scalardl-ledger-byol:${SCALARDL_VERSION}
2828
```
2929
30-
2. ScalarDL Ledger のライセンスキーを設定します。<code>docker-compose-ledger-{props.shortName}.yml</code> ファイルで、`<SET_YOUR_LICENSE_KEY>` をライセンスキーに置き換えます。例:
30+
2. ScalarDL Ledger のライセンスキーを設定します。<code>{props.shortName}/ledger.properties</code> ファイルで、`<SET_YOUR_LICENSE_KEY>` をライセンスキーに置き換えます。例:
3131

32-
```yaml
33-
services:
34-
scalar-ledger:
35-
environment:
36-
- SCALAR_DL_LICENSING_LICENSE_KEY={"organization_name":"XXXXXXXX","expiration_date_time":"YYYY-MM-DDTHH:mm:SS+TIMEZONE","product_name":"ScalarDL Ledger","product_version":N,"license_type":"trial","signature":"XXXXXXXX"}
32+
```properties
33+
##### PLEASE REPLACE THIS VALUE WITH YOUR LICENSE KEY (ENTERPRISE EDITION ONLY) #####
34+
scalar.dl.licensing.license_key={"organization_name":"XXXXXXXX","expiration_date_time":"YYYY-MM-DDTHH:mm:SS+TIMEZONE","product_name":"ScalarDL Ledger","product_version":N,"license_type":"trial","signature":"XXXXXXXX"}
35+
##### PLEASE REPLACE THIS VALUE WITH YOUR LICENSE KEY (ENTERPRISE EDITION ONLY) #####
3736
```
3837

39-
3. ライセンスを確認するには、<code>docker-compose-ledger-{props.shortName}.yml</code> ファイルを次のように更新します。試用版ライセンスを使用している場合は、この手順をスキップしてください。
38+
3. ライセンスを確認するには、<code>{props.shortName}/docker-compose-ledger.yml</code> ファイルを次のように更新します。試用版ライセンスを使用している場合は、この手順をスキップしてください。
4039

4140
- 証明書ファイルのパスを変更する前に (デフォルト設定):
4241

4342
```yaml
4443
services:
45-
scalar-ledger:
44+
scalardl-ledger:
4645
volumes:
47-
- ./fixture/ledger-key.pem:/scalar/ledger-key.pem
48-
- ./fixture/ledger.properties.tmpl:/scalar/ledger/ledger.properties.tmpl
49-
- ./fixture/trial-license-cert.pem:/scalar/license-cert.pem
46+
- ./ledger.properties:/scalar/ledger/ledger.properties.tmpl
47+
- ../fixture/ledger-key.pem:/scalar/ledger-key.pem
48+
- ../fixture/trial-license-cert.pem:/scalar/license-cert.pem
5049
# If you have a commercial license key, you must use `commercial-license-cert.pem` instead of `trial-license-cert.pem`.
51-
# - ./fixture/commercial-license-cert.pem:/scalar/license-cert.pem
50+
# - ../fixture/commercial-license-cert.pem:/scalar/license-cert.pem
5251
```
5352

5453
- 証明書ファイルのパスを変更した後:
5554

5655
```yaml
5756
services:
58-
scalar-ledger:
57+
scalardl-ledger:
5958
volumes:
60-
- ./fixture/ledger-key.pem:/scalar/ledger-key.pem
61-
- ./fixture/ledger.properties.tmpl:/scalar/ledger/ledger.properties.tmpl
62-
# - ./fixture/trial-license-cert.pem:/scalar/license-cert.pem
59+
- ./ledger.properties:/scalar/ledger/ledger.properties.tmpl
60+
- ../fixture/ledger-key.pem:/scalar/ledger-key.pem
61+
# - ../fixture/trial-license-cert.pem:/scalar/license-cert.pem
6362
# If you have a commercial license key, you must use `commercial-license-cert.pem` instead of `trial-license-cert.pem`.
64-
- ./fixture/commercial-license-cert.pem:/scalar/license-cert.pem
63+
- ../fixture/commercial-license-cert.pem:/scalar/license-cert.pem
6564
```
6665
6766
</details>
@@ -72,12 +71,12 @@ ScalarDL Enterprise Edition を使用している場合は、次のようにラ
7271
7372
1. 次のコマンドを実行して、{props.productName} をローカルで実行します。
7473
75-
<CodeBlock language="console">docker compose -f docker-compose-ledger-{props.shortName}.yml up -d {props.shortName}</CodeBlock>
74+
<CodeBlock language="console">docker compose -f {props.shortName}/docker-compose-ledger.yml up -d {props.shortName}</CodeBlock>
7675
7776
2. 次のコマンドを実行して、ScalarDL Ledger のデータベーススキーマをロードします。
7877
79-
<CodeBlock language="console">docker compose -f docker-compose-ledger-{props.shortName}.yml up -d scalardl-ledger-schema-loader</CodeBlock>
78+
<CodeBlock language="console">docker compose -f {props.shortName}/docker-compose-ledger.yml up -d scalardl-ledger-schema-loader</CodeBlock>
8079
8180
3. 次のコマンドを実行して ScalarDL Ledger および依存するコンポーネントを起動します。
8281
83-
<CodeBlock language="console">docker compose -f docker-compose-ledger-{props.shortName}.yml up -d</CodeBlock>
82+
<CodeBlock language="console">docker compose -f {props.shortName}/docker-compose-ledger.yml up -d</CodeBlock>

0 commit comments

Comments
 (0)