doc/_includes/_install_custom_certificates.liquid

   1 {% comment %}
   2 Copyright (C) The Arvados Authors. All rights reserved.
   3
   4 SPDX-License-Identifier: CC-BY-SA-3.0
   5 {% endcomment %}
   6
   7 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.
   8
   9 For a @single hostname@ setup, the certificate and its key need to be copied to a file named after @HOSTNAME_EXT@.
  10
  11 For example, if @HOSTNAME_EXT@ is defined as @my-arvados.example.net@, the script will look for
  12
  13 <notextile>
  14 <pre><code>${CUSTOM_CERTS_DIR}/my-arvados.example.net.crt
  15 ${CUSTOM_CERTS_DIR}/my-arvados.example.net.key
  16 </code></pre>
  17 </notextile>
  18
  19 For a @multiple hostnames@ setup, the script expects cert/key files with these basenames (matching the role except for <i>keepweb</i>, which is split in both <i>download / collections</i>):
  20
  21 * "controller"
  22 * "websocket"
  23 * "workbench"
  24 * "workbench2"
  25 * "webshell"
  26 * "download"         # Part of keepweb
  27 * "collections"      # Part of keepweb
  28 * "keepproxy"
  29
  30 E.g. for 'keepproxy', the script will look for
  31
  32 <notextile>
  33 <pre><code>${CUSTOM_CERTS_DIR}/keepproxy.crt
  34 ${CUSTOM_CERTS_DIR}/keepproxy.key
  35 </code></pre>
  36 </notextile>
  37
  38 All certificate files will be used by nginx. You may need to include intermediate certificates in your certificate files. See "the nginx documentation":http://nginx.org/en/docs/http/configuring_https_servers.html#chains for more details.
  39
  40 Make sure that all the FQDNs that you will use for the public-facing applications (API/controller, Workbench, Keepproxy/Keepweb) are reachable.