Skip to content

Commit 52fc0de

Browse files
committed
/packages/doltlab/content/reference/installer: update docs for deprecated and new field
1 parent 46068f5 commit 52fc0de

File tree

2 files changed

+25
-4
lines changed

2 files changed

+25
-4
lines changed

packages/doltlab/content/reference/installer/cli.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -643,10 +643,16 @@ Configuration file equivalent [super_admins](./configuration-file.md#super_admin
643643

644644
## tls-cert-chain
645645

646-
_String_. Absolute path to TLS certificate chain with `.pem` extension. DoltLab Enterprise only.
646+
_String_. Deprecated, use `tls-full-chain-cert` instead. Absolute path to a TLS full chain certificate with `.pem` extension. DoltLab Enterprise only.
647647

648648
Configuration file equivalent [cert_chain](./configuration-file.md#cert_chain).
649649

650+
## tls-full-chain-cert
651+
652+
_String_. Absolute path to a TLS full chain certificate with `.pem` extension. DoltLab Enterprise only.
653+
654+
Configuration file equivalent [full_chain_cert](./configuration-file.md#full_chain_cert).
655+
650656
## tls-private-key
651657

652658
_String_. Absolute path to TLS private key with `.pem` extension. DoltLab Enterprise only.

packages/doltlab/content/reference/installer/configuration-file.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,8 @@ enterprise:
117117
no_multihost_default_placement_preferences_spreads: false
118118
scheme: "http"
119119
tls:
120-
cert_chain: "/path/to/cert.pem"
120+
cert_chain: "/path/to/cert.pem" # Deprecated: use `full_chain_cert` instead.
121+
full_chain_cert: "/path/to/cert.pem"
121122
private_key: "/path/to/key.pem"
122123
smtp:
123124
host: "smtp.email.com"
@@ -1305,12 +1306,13 @@ Command line equivalent [scheme](./cli.md#scheme).
13051306

13061307
_Dictionary_. TLS configuration options. DoltLab Enterprise only. _Optional_. See [serving DoltLab natively over HTTPS](../../guides/enterprise.md#serve-doltlab-over-https-natively) for more information.
13071308

1308-
- [cert_chain](#cert_chain)
1309+
- [cert_chain](#cert_chain) Deprecated, use `full_chain_cert` instead.
1310+
- [full_chain_cert](#full_chain_cert)
13091311
- [private_key](#private_key)
13101312

13111313
### cert_chain
13121314

1313-
_String_. The absolute path to a TLS certificate chain with `.pem` extension. _Required_.
1315+
_String_. Deprecated, use `full_chain_cert` instead. The absolute path to a TLS full chain certificate with `.pem` extension. _Required_.
13141316

13151317
```yaml
13161318
# example installer_config.yaml
@@ -1321,6 +1323,19 @@ enterprise:
13211323

13221324
Command line equivalent [tls-cert-chain](./cli.md#tls-cert-chain).
13231325

1326+
### full_chain_cert
1327+
1328+
_String_. The absolute path to a TLS full chain certificate with `.pem` extension. _Required_.
1329+
1330+
```yaml
1331+
# example installer_config.yaml
1332+
enterprise:
1333+
tls:
1334+
full_chain_cert: /path/to/tls/cert/chain.pem
1335+
```
1336+
1337+
Command line equivalent [tls-full-chain-cert](./cli.md#tls-full-chain-cert).
1338+
13241339
### private_key
13251340

13261341
_String_. The absolute path to a TLS private key with `.pem` extension. _Required_.

0 commit comments

Comments
 (0)