Back to Lego

VK Cloud

docs/content/dns/zz_gen_vkcloud.md

4.35.22.7 KB
Original Source
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- providers/dns/vkcloud/vkcloud.toml --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->

Configuration for VK Cloud.

<!--more-->
  • Code: vkcloud
  • Since: v4.9.0

Here is an example bash command using the VK Cloud provider:

bash
VK_CLOUD_PROJECT_ID="<your_project_id>" \
VK_CLOUD_USERNAME="<your_email>" \
VK_CLOUD_PASSWORD="<your_password>" \
lego --dns vkcloud -d '*.example.com' -d example.com run

Credentials

Environment Variable NameDescription
VK_CLOUD_PASSWORDPassword for VK Cloud account
VK_CLOUD_PROJECT_IDString ID of project in VK Cloud
VK_CLOUD_USERNAMEEmail of VK Cloud account

The environment variable names can be suffixed by _FILE to reference a file instead of a value. More information [here]({{% ref "dns#configuration-and-credentials" %}}).

Additional Configuration

Environment Variable NameDescription
VK_CLOUD_DNS_ENDPOINTURL of DNS API. Defaults to https://mcs.mail.ru/public-dns but can be changed for usage with private clouds
VK_CLOUD_DOMAIN_NAMEOpenstack users domain name. Defaults to users but can be changed for usage with private clouds
VK_CLOUD_IDENTITY_ENDPOINTURL of OpenStack Auth API, Defaults to https://infra.mail.ru:35357/v3/ but can be changed for usage with private clouds
VK_CLOUD_POLLING_INTERVALTime between DNS propagation check in seconds (Default: 2)
VK_CLOUD_PROPAGATION_TIMEOUTMaximum waiting time for DNS propagation in seconds (Default: 60)
VK_CLOUD_TTLThe TTL of the TXT record used for the DNS challenge in seconds (Default: 60)

The environment variable names can be suffixed by _FILE to reference a file instead of a value. More information [here]({{% ref "dns#configuration-and-credentials" %}}).

Credential information

You can find all required and additional information on "Project/Keys" page of your cloud.

ENV VariableParameter from page
VK_CLOUD_PROJECT_IDProject ID
VK_CLOUD_USERNAMEUsername
VK_CLOUD_DOMAIN_NAMEUser Domain Name
VK_CLOUD_IDENTITY_ENDPOINTIdentity endpoint

More information

<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- providers/dns/vkcloud/vkcloud.toml --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->