doc/_includes/_ssl_config_multi.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 h2(#certificates). Choose the SSL/TLS configuration (SSL_MODE)
   8
   9 Arvados requires a valid TLS certificate to work correctly. This installer supports these options:
  10
  11 # @lets-encrypt@: "automatically obtain and install an SSL certificates for your hostnames":#lets-encrypt
  12 # @bring-your-own@: "supply your own certificates in the @certs@ directory":#bring-your-own
  13
  14 h3(#lets-encrypt). Using a Let's Encrypt certificate
  15
  16 In the default configuration, this installer gets a valid certificate via Let's Encrypt. If you have the <b>CLUSTER.DOMAIN</b> domain in a route53 zone, you can set <b>USE_LETSENCRYPT_ROUTE53</b> to <b>YES</b> and supply appropriate credentials so that Let's Encrypt can use dns-01 validation to get the appropriate certificates.
  17
  18 <notextile>
  19 <pre><code>SSL_MODE="lets-encrypt"
  20 USE_LETSENCRYPT_ROUTE53="yes"
  21 LE_AWS_REGION="us-east-1"
  22 LE_AWS_ACCESS_KEY_ID="AKIABCDEFGHIJKLMNOPQ"
  23 LE_AWS_SECRET_ACCESS_KEY="thisistherandomstringthatisyoursecretkey"
  24 </code></pre>
  25 </notextile>
  26
  27 Please note that when using AWS, EC2 instances can have a default hostname that ends with <i>amazonaws.com</i>. Let's Encrypt has a blacklist of domain names for which it will not issue certificates, and that blacklist includes the <i>amazonaws.com</i> domain, which means the default hostname can not be used to get a certificate from Let's Encrypt.
  28
  29 h3(#bring-your-own). Bring your own certificates
  30
  31 To supply your own certificates, change the configuration like this:
  32
  33 <notextile>
  34 <pre><code>SSL_MODE="bring-your-own"
  35 </code></pre>
  36 </notextile>
  37
  38 {% include 'multi_host_install_custom_certificates' %}
  39
  40 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.