diff --git a/cli/commands.mdx b/cli/commands.mdx index 512119d4ca..4525297e47 100644 --- a/cli/commands.mdx +++ b/cli/commands.mdx @@ -107,6 +107,42 @@ mint status --- +## `mint add-domain` + +Add a [custom domain](/customize/custom-domain) to your deployment from the terminal. Requires authentication with `mint login`. + +```bash +mint add-domain +``` + +| Argument | Description | +| --- | --- | +| `domain` | The custom domain to add, like `docs.example.com`. Must be a bare hostname. | + +The command uses your configured subdomain from `mint config`. If you do not have a configured subdomain, it uses the first subdomain on your account. + +After registering the domain, the CLI waits up to 10 seconds for DNS records to generate, then prints the `TXT` and `CNAME` records to add at your domain provider: + +```text +TXT _acme-challenge → +TXT _cf-custom-hostname → +CNAME @ → cname.mintlify.builders +``` + +Add the `TXT` records first, then add the `CNAME` once the verification records validate. See [Custom domain](/customize/custom-domain) for full DNS setup instructions, apex domain requirements, and TLS provisioning details. + + + If some `TXT` records are still generating when the command exits, check the [Custom domain setup](https://app.mintlify.com/settings/deployment/custom-domain) page in your dashboard for the remaining values. + + +### Example + +```bash +mint add-domain docs.example.com +``` + +--- + ## `mint automations` Create, list, and delete [automations](/automations) from the terminal. Requires authentication with `mint login`. diff --git a/customize/custom-domain.mdx b/customize/custom-domain.mdx index 162a045c6a..fad503aae5 100644 --- a/customize/custom-domain.mdx +++ b/customize/custom-domain.mdx @@ -37,6 +37,10 @@ If your domain traffic routes to Mintlify, the dashboard displays the DNS record If you proxy only your subpath to Mintlify, the dashboard displays reverse proxy setup guides instead. Follow the guide for your provider and see [Host docs at a subpath](/deploy/docs-subpath) for more information. + + You can also add a domain from the terminal with [`mint add-domain `](/cli/commands#mint-add-domain). The command registers the domain on your deployment and prints the DNS records to configure. + + ### Base path requirements Your base path can be any path that meets these requirements: diff --git a/es/cli/commands.mdx b/es/cli/commands.mdx index 5fafeade3a..a3d644d762 100644 --- a/es/cli/commands.mdx +++ b/es/cli/commands.mdx @@ -121,6 +121,44 @@ mint status --- +
+ ## `mint add-domain` +
+ +Añade un [dominio personalizado](/es/customize/custom-domain) a tu implementación desde la terminal. Requiere autenticación con `mint login`. + +```bash +mint add-domain +``` + +| Argumento | Descripción | +| --- | --- | +| `domain` | El dominio personalizado que quieres añadir, como `docs.example.com`. Debe ser un nombre de host simple. | + +El comando usa el subdominio configurado con `mint config`. Si no hay ninguno configurado, usa el primer subdominio de tu cuenta. + +Una vez registrado el dominio, la CLI espera hasta 10 segundos a que se generen los registros DNS y luego imprime los registros `TXT` y `CNAME` que debes añadir en tu proveedor de dominio: + +```text +TXT _acme-challenge → +TXT _cf-custom-hostname → +CNAME @ → cname.mintlify.builders +``` + +Añade primero los registros `TXT` y, una vez validados, añade el `CNAME`. Consulta [Dominio personalizado](/es/customize/custom-domain) para ver las instrucciones completas de configuración de DNS, los requisitos para dominios apex y los detalles del aprovisionamiento de TLS. + + + Si algunos registros `TXT` aún se están generando cuando el comando finaliza, revisa la página de [Configuración de dominio personalizado](https://app.mintlify.com/settings/deployment/custom-domain) en tu panel para ver los valores restantes. + + +### Ejemplo + +```bash +mint add-domain docs.example.com +``` + +--- +
## `mint automations`
diff --git a/es/customize/custom-domain.mdx b/es/customize/custom-domain.mdx index 71359dc04f..723e68759f 100644 --- a/es/customize/custom-domain.mdx +++ b/es/customize/custom-domain.mdx @@ -41,6 +41,10 @@ Si el tráfico de tu dominio se enruta a Mintlify, el dashboard muestra los regi Si solo redireccionas tu subruta a Mintlify, el dashboard muestra guías de configuración de proxy inverso en su lugar. Sigue la guía correspondiente a tu proveedor y consulta [Alojar la documentación en una subruta](/es/deploy/docs-subpath) para más información. + + También puedes añadir un dominio desde la terminal con [`mint add-domain `](/es/cli/commands#mint-add-domain). El comando registra el dominio en tu implementación e imprime los registros DNS que debes configurar. + +
### Requisitos de la ruta base
diff --git a/fr/cli/commands.mdx b/fr/cli/commands.mdx index 5881477c9b..215367fed9 100644 --- a/fr/cli/commands.mdx +++ b/fr/cli/commands.mdx @@ -121,6 +121,46 @@ mint status --- +
+ ## `mint add-domain` +
+ +Ajoutez un [domaine personnalisé](/fr/customize/custom-domain) à votre déploiement depuis le terminal. Nécessite une authentification avec `mint login`. + +```bash +mint add-domain +``` + +| Argument | Description | +| --- | --- | +| `domain` | Le domaine personnalisé à ajouter, par exemple `docs.example.com`. Doit être un nom d'hôte simple. | + +La commande utilise le sous-domaine configuré via `mint config`. Si aucun n'est défini, elle utilise le premier sous-domaine de votre compte. + +Une fois le domaine enregistré, la CLI attend jusqu'à 10 secondes que les enregistrements DNS soient générés, puis affiche les enregistrements `TXT` et `CNAME` à ajouter chez votre fournisseur de domaine : + +```text +TXT _acme-challenge → +TXT _cf-custom-hostname → +CNAME @ → cname.mintlify.builders +``` + +Ajoutez d'abord les enregistrements `TXT`, puis ajoutez le `CNAME` une fois les enregistrements de vérification validés. Consultez [Domaine personnalisé](/fr/customize/custom-domain) pour les instructions complètes de configuration DNS, les exigences pour les domaines apex et les détails sur le provisionnement TLS. + + + Si certains enregistrements `TXT` sont encore en cours de génération à la fin de la commande, consultez la page [Configuration du domaine personnalisé](https://app.mintlify.com/settings/deployment/custom-domain) dans votre Dashboard pour récupérer les valeurs restantes. + + +
+ ### Exemple +
+ +```bash +mint add-domain docs.example.com +``` + +--- +
## `mint automations`
diff --git a/fr/customize/custom-domain.mdx b/fr/customize/custom-domain.mdx index abaf042993..4c66033aa9 100644 --- a/fr/customize/custom-domain.mdx +++ b/fr/customize/custom-domain.mdx @@ -41,6 +41,10 @@ Si le trafic de votre domaine est acheminé vers Mintlify, le Dashboard affiche Si vous ne transmettez que votre sous-chemin à Mintlify via un proxy, le Dashboard affiche à la place des guides de configuration de proxy inverse. Suivez le guide correspondant à votre fournisseur et consultez [Héberger la documentation sur un sous-chemin](/fr/deploy/docs-subpath) pour plus d’informations. + + Vous pouvez également ajouter un domaine depuis le terminal avec [`mint add-domain `](/fr/cli/commands#mint-add-domain). La commande enregistre le domaine sur votre déploiement et affiche les enregistrements DNS à configurer. + +
### Exigences relatives au chemin de base
diff --git a/zh/cli/commands.mdx b/zh/cli/commands.mdx index 96d0cc6386..da8b682719 100644 --- a/zh/cli/commands.mdx +++ b/zh/cli/commands.mdx @@ -121,6 +121,46 @@ mint status --- +
+ ## `mint add-domain` +
+ +从终端为你的部署添加一个[自定义域名](/zh/customize/custom-domain)。需要使用 `mint login` 进行身份验证。 + +```bash +mint add-domain +``` + +| 参数 | 描述 | +| --- | --- | +| `domain` | 要添加的自定义域名，例如 `docs.example.com`。必须是纯主机名。 | + +该命令使用通过 `mint config` 配置的子域名。如果未设置，则使用账户中的第一个子域名。 + +域名注册后，CLI 将等待最长 10 秒以生成 DNS 记录，然后打印需要在你的域名提供商处添加的 `TXT` 和 `CNAME` 记录： + +```text +TXT _acme-challenge → +TXT _cf-custom-hostname → +CNAME @ → cname.mintlify.builders +``` + +请先添加 `TXT` 记录，验证记录通过后再添加 `CNAME`。有关完整的 DNS 配置说明、顶级域名要求和 TLS 配置详情，请参见[自定义域名](/zh/customize/custom-domain)。 + + + 如果命令结束时某些 `TXT` 记录仍在生成中，请稍后前往控制台的 [Custom domain setup](https://app.mintlify.com/settings/deployment/custom-domain) 页面查看剩余的值。 + + +
+ ### 示例 +
+ +```bash +mint add-domain docs.example.com +``` + +--- +
## `mint automations`
diff --git a/zh/customize/custom-domain.mdx b/zh/customize/custom-domain.mdx index 9faff3bbfb..749599ef81 100644 --- a/zh/customize/custom-domain.mdx +++ b/zh/customize/custom-domain.mdx @@ -41,6 +41,10 @@ keywords: ["自定义域名配置", "DNS 配置", "CNAME 记录", "TLS 证书", 如果你只是将子路径代理到 Mintlify，控制台会改为显示反向代理的设置指南。请按照适用于你提供商的指南操作，并参阅 [在子路径下托管文档](/zh/deploy/docs-subpath) 获取更多信息。 + + 你也可以从终端使用 [`mint add-domain `](/zh/cli/commands#mint-add-domain) 添加域名。该命令会在你的部署上注册该域名，并打印需要配置的 DNS 记录。 + +
### 基础路径要求