Update arvbox docs to describe how to install root cert

[arvados.git] / doc / install / arvbox.html.textile.liquid

diff --git a/doc/install/arvbox.html.textile.liquid b/doc/install/arvbox.html.textile.liquid
index 8827cf8abfd2b1fcbe73849268d7124f43973adf..2d94d32ac5edbb844eaa9dca37c18d49aef7a689 100644 (file)
--- a/doc/install/arvbox.html.textile.liquid
+++ b/doc/install/arvbox.html.textile.liquid
@@ -31,17 +31,19 @@ h2. Usage
 $ arvbox
 Arvados-in-a-box                      http://arvados.org
 
-build   <config>      build arvbox Docker image
-rebuild <config>      build arvbox Docker image, no layer cache
-start|run <config>  start arvbox container
-open       open arvbox workbench in a web browser
-shell      enter arvbox shell
-ip         print arvbox docker container ip address
-host       print arvbox published host
-status     print some information about current arvbox
+start|run <config> [tag]  start arvbox container
 stop       stop arvbox container
 restart <config>  stop, then run again
-reboot  <config>  stop, build arvbox Docker image, run
+status     print some information about current arvbox
+ip         print arvbox docker container ip address
+host       print arvbox published host
+shell      enter arvbox shell
+open       open arvbox workbench in a web browser
+root-cert  get copy of root certificate
+update  <config> stop, pull latest image, run
+build   <config> build arvbox Docker image
+reboot  <config> stop, build arvbox Docker image, run
+rebuild <config> build arvbox Docker image, no layer cache
 reset      delete arvbox arvados data (be careful!)
 destroy    delete all arvbox code and data (be careful!)
 log <service> tail log of specified service
@@ -52,6 +54,23 @@ sv <start|stop|restart> <service> change state of service inside arvbox
 clone <from> <to>   clone an arvbox
 </pre>
 
+h2. Install root certificate
+
+Arvbox creates root certificate to authorize Arvbox services.  Installing the root certificate into your web browser will prevent security errors when accessing Arvbox services with your web browser.  Every  Arvbox instance generates a new root signing key.
+
+# Export the certificate using @arvbox root-cert@
+# Go to the certificate manager in your browser.
+#* In Chrome, this can be found under "Settings &rarr; Advanced &rarr; Manage Certificates" or by entering @chrome://settings/certificates@ in the URL bar.
+#* In Firefox, this can be found under "Preferences &rarr; Privacy & Security" or entering @about:preferences#privacy@ in the URL bar and then choosing "View Certificates...".
+# Select the "Authorities" tab, then press the "Import" button.  Choose @arvbox-root-cert.pem@
+
+The certificate will be added under the "Arvados testing" organization as "arvbox testing root CA".
+
+To access your Arvbox instance using command line clients (such as arv-get and arv-put) without security errors, install the certificate into the OS certificate storage (instructions for Debian/Ubuntu):
+
+# copy @arvbox-root-cert.pem@ to @/usr/local/share/ca-certificates/@
+# run @/usr/sbin/update-ca-certificates@
+
 h2. Configs
 
 h3. dev