X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/3a26616cec20d3cf9d3ac0d3f3930bf217ec7b64..bf81b84851b7fe2271b46655d79e73d76311c37a:/doc/_includes/_install_custom_certificates.liquid diff --git a/doc/_includes/_install_custom_certificates.liquid b/doc/_includes/_install_custom_certificates.liquid index a6d809d151..80878c0498 100644 --- a/doc/_includes/_install_custom_certificates.liquid +++ b/doc/_includes/_install_custom_certificates.liquid @@ -4,17 +4,19 @@ Copyright (C) The Arvados Authors. All rights reserved. SPDX-License-Identifier: CC-BY-SA-3.0 {% endcomment %} -If you plan to use custom certificates, please set the variable SSL_MODE=bring-your-own and copy your certificates to the directory specified with the variable @CUSTOM_CERTS_DIR@ (usually "./certs") in the remote directory where you copied the @provision.sh@ script. From this dir, the provision script will install the certificates required for the role you're installing. +Copy your certificates to the directory specified with the variable @CUSTOM_CERTS_DIR@ in the remote directory where you copied the @provision.sh@ script. The provision script will find the certificates there. + +For a @single hostname@ setup, the certificate and its key need to be copied to a file named after @HOSTNAME_EXT@. + +For example, if @HOSTNAME_EXT@ is defined as @my-arvados.example.net@, the script will look for -When using custom certificates in a single-host / single-hostname setup, the certificate and its key need to be copied to a file named after ${HOSTNAME_EXT}. Ie., for "HOSTNAME_EXT='my-arvados.example.net', the script will lookup for -

-# ${CUSTOM_CERTS_DIR}/my-arvados.example.net.crt
-# ${CUSTOM_CERTS_DIR}/my-arvados.example.net.key
+
${CUSTOM_CERTS_DIR}/my-arvados.example.net.crt
+${CUSTOM_CERTS_DIR}/my-arvados.example.net.key
 
-For a setup with multiple hostnames, the script expects cert/key files with these basenames (matching the role except for keepweb, which is split in both download / collections): +For a @multiple hostnames@ setup, the script expects cert/key files with these basenames (matching the role except for keepweb, which is split in both download / collections): * "controller" * "websocket" @@ -25,7 +27,7 @@ For a setup with multiple hostnames, the script expects cert/key files with thes * "collections" # Part of keepweb * "keepproxy" -Ie., for 'keepproxy', the script will look for +E.g. for 'keepproxy', the script will look for
${CUSTOM_CERTS_DIR}/keepproxy.crt