Skip to content

Commit 1ebbbcf

Browse files
AUTO: Sync ScalarDL docs in English to docs site repo (#864)
Co-authored-by: josh-wong <[email protected]>
1 parent b4eb63f commit 1ebbbcf

File tree

1 file changed

+26
-30
lines changed

1 file changed

+26
-30
lines changed

versioned_docs/version-3.9/getting-started.mdx

Lines changed: 26 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -81,61 +81,60 @@ Select your database, and follow the instructions to deploy ScalarDL Ledger with
8181
<details>
8282
<summary>See here to set up your license</summary>
8383

84-
1. Enable the Docker image for the Enterprise edition in the `docker-compose-ledger-cosmosdb.yml` file as follows:
84+
1. Enable the Docker image for the Enterprise edition in the `cosmosdb/docker-compose-ledger.yml` file as follows:
8585

8686
- Before changing the image (default configuration):
8787

8888
```yaml
8989
services:
90-
scalar-ledger:
90+
scalardl-ledger:
9191
image: ghcr.io/scalar-labs/scalardl-ledger:${SCALARDL_VERSION}
9292
# image: ghcr.io/scalar-labs/scalardl-ledger-byol:${SCALARDL_VERSION}
9393
```
9494

95-
- After changing the image:
95+
- After changing the image:
9696

9797
```yaml
9898
services:
99-
scalar-ledger:
99+
scalardl-ledger:
100100
# image: ghcr.io/scalar-labs/scalardl-ledger:${SCALARDL_VERSION}
101101
image: ghcr.io/scalar-labs/scalardl-ledger-byol:${SCALARDL_VERSION}
102102
```
103103
104-
2. Set your license key for ScalarDL Ledger. In the `docker-compose-ledger-cosmosdb.yml` file, replace `<SET_YOUR_LICENSE_KEY>` with your license key. For example:
104+
2. Set your license key for ScalarDL Ledger. In the `cosmosdb/ledger.properties` file, replace `<SET_YOUR_LICENSE_KEY>` with your license key. For example:
105105

106-
```yaml
107-
services:
108-
scalar-ledger:
109-
environment:
110-
- 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"}
106+
```properties
107+
##### PLEASE REPLACE THIS VALUE WITH YOUR LICENSE KEY (ENTERPRISE EDITION ONLY) #####
108+
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"}
109+
##### PLEASE REPLACE THIS VALUE WITH YOUR LICENSE KEY (ENTERPRISE EDITION ONLY) #####
111110
```
112111

113-
3. To check the license, update the `docker-compose-ledger-cosmosdb.yml` file as follows. If you're using a trial license, skip this step.
112+
3. To check the license, update the `cosmosdb/docker-compose-ledger.yml` file as follows. If you're using a trial license, skip this step.
114113

115114
- Before changing the certificate file path (default configuration):
116115

117116
```yaml
118117
services:
119-
scalar-ledger:
118+
scalardl-ledger:
120119
volumes:
121-
- ./fixture/ledger-key.pem:/scalar/ledger-key.pem
122-
- ./fixture/ledger.properties.tmpl:/scalar/ledger/ledger.properties.tmpl
123-
- ./fixture/trial-license-cert.pem:/scalar/license-cert.pem
120+
- ./ledger.properties:/scalar/ledger/ledger.properties.tmpl
121+
- ../fixture/ledger-key.pem:/scalar/ledger-key.pem
122+
- ../fixture/trial-license-cert.pem:/scalar/license-cert.pem
124123
# If you have a commercial license key, you must use `commercial-license-cert.pem` instead of `trial-license-cert.pem`.
125-
# - ./fixture/commercial-license-cert.pem:/scalar/license-cert.pem
124+
# - ../fixture/commercial-license-cert.pem:/scalar/license-cert.pem
126125
```
127126

128127
- After changing the certificate file path:
129128

130129
```yaml
131130
services:
132-
scalar-ledger:
131+
scalardl-ledger:
133132
volumes:
134-
- ./fixture/ledger-key.pem:/scalar/ledger-key.pem
135-
- ./fixture/ledger.properties.tmpl:/scalar/ledger/ledger.properties.tmpl
136-
# - ./fixture/trial-license-cert.pem:/scalar/license-cert.pem
133+
- ./ledger.properties:/scalar/ledger/ledger.properties.tmpl
134+
- ../fixture/ledger-key.pem:/scalar/ledger-key.pem
135+
# - ../fixture/trial-license-cert.pem:/scalar/license-cert.pem
137136
# If you have a commercial license key, you must use `commercial-license-cert.pem` instead of `trial-license-cert.pem`.
138-
- ./fixture/commercial-license-cert.pem:/scalar/license-cert.pem
137+
- ../fixture/commercial-license-cert.pem:/scalar/license-cert.pem
139138
```
140139
141140
</details>
@@ -148,26 +147,23 @@ Select your database, and follow the instructions to deploy ScalarDL Ledger with
148147
149148
To use Azure Cosmos DB for NoSQL, you must have an Azure account. If you don't have an Azure account, visit [Create an Azure Cosmos DB account](https://learn.microsoft.com/en-us/azure/cosmos-db/nosql/quickstart-portal#create-account).
150149
151-
After setting up Cosmos DB for NoSQL, modify the following items in `docker-compose-ledger-cosmodb.yml` based on your configuration of Cosmos DB for NoSQL.
150+
After setting up Cosmos DB for NoSQL, modify the following items in `cosmodb/ledger.properties` based on your configuration of Cosmos DB for NoSQL.
152151

153-
```yaml
154-
services:
155-
scalar-ledger:
156-
environment:
157-
- SCALAR_DB_CONTACT_POINTS=<COSMOS_DB_FOR_NOSQL_URI>
158-
- SCALAR_DB_PASSWORD=<COSMOS_DB_FOR_NOSQL_KEY>
152+
```properties
153+
scalar.db.contact_points=<COSMOS_DB_FOR_NOSQL_URI>
154+
scalar.db.password=<COSMOS_DB_FOR_NOSQL_KEY>
159155
```
160156

161157
2. Load the database schema for ScalarDL Ledger by running the following command:
162158

163159
```console
164-
docker compose -f docker-compose-ledger-cosmosdb.yml up -d scalardl-ledger-schema-loader
160+
docker compose -f cosmosdb/docker-compose-ledger.yml up -d scalardl-ledger-schema-loader
165161
```
166162

167163
3. Run ScalarDL Ledger by running the following command:
168164

169165
```console
170-
docker compose -f docker-compose-ledger-cosmosdb.yml up -d
166+
docker compose -f cosmosdb/docker-compose-ledger.yml up -d
171167
```
172168
</TabItem>
173169

0 commit comments

Comments
 (0)