doc/_includes/_install_ca_cert.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(#ca_root_certificate). Install the CA root certificate (SSL_MODE=self-signed only)
   8
   9 *If you are not using self-signed certificates (you selected SSL_MODE=lets-encrypt or SSL_MODE=bring-your-own), skip this section.*
  10
  11 Arvados uses SSL to encrypt communications. The web interface uses AJAX which will silently fail if the certificate is not valid or signed by an unknown Certification Authority.
  12
  13 For this reason, the @arvados-formula@ has a helper state to create a root certificate to authorize Arvados services. The @provision.sh@ script will leave a copy of the generated CA's certificate (@arvados-snakeoil-ca.pem@) in the script's directory so you can add it to your workstation.
  14
  15 h3. Web Browser
  16
  17 Installing the root certificate into your web browser will prevent security errors when accessing Arvados services with your web browser.
  18
  19 h4. Chrome
  20
  21 # Go to "Settings &rarr; Privacy and Security &rarr; Security &rarr; Manage Certificates" or enter @chrome://settings/certificates@ in the URL bar.
  22 # *Click on the "Authorities" tab*  (it is not selected by default)
  23 # Click on the "Import" button
  24 # Choose @arvados-snakeoil-ca.pem@
  25 # Tick the checkbox next to "Trust this certificate for identifying websites"
  26 # Hit OK
  27 # The certificate should appear in the list of Authorities under "Arvados"
  28
  29 h4. Firefox
  30
  31 # Go to "Preferences &rarr; Privacy &amp; Security" or enter @about:preferences#privacy@ in the URL bar
  32 # Scroll down to the *Certificates* section
  33 # Click on the button "View Certificates...".
  34 # Make sure the "Authorities" tab is selected
  35 # Press the "Import..." button.
  36 # Choose @arvados-snakeoil-ca.pem@
  37 # Tick the checkbox next to "Trust this CA to identify websites"
  38 # Hit OK
  39 # The certificate should appear in the list of Authorities under "Arvados"
  40
  41 h4. Other browsers (Safari, etc)
  42
  43 The process will be similar to that of Chrome and Firefox, but the exact user interface will be different.  If you can't figure it out, try searching for "how do I install a custom certificate authority in <my browser>".
  44
  45 h3. Installation on Linux OS certificate storage
  46
  47 To access your Arvados instance using command line clients (such as @arv-get@ and @arv-put@) without security errors, install the certificate into the OS certificate storage.
  48
  49 h4. Debian/Ubuntu
  50
  51 *Important* the certificate file added to @ca-certificates@ must have the extension @.crt@ or it won't be recognized.
  52
  53 <notextile>
  54 <pre><code>cp arvados-snakeoil-ca.pem /usr/local/share/ca-certificates/arvados-snakeoil-ca.crt
  55 /usr/sbin/update-ca-certificates
  56 </code></pre>
  57 </notextile>
  58
  59 h4. CentOS
  60
  61 <notextile>
  62 <pre><code>cp arvados-snakeoil-ca.pem /etc/pki/ca-trust/source/anchors/
  63 /usr/bin/update-ca-trust
  64 </code></pre>
  65 </notextile>