X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/248c7167e95d970b770c43102ee68cf1319973f7..3d2b1ba10a5739e49d26658fa7aaf090dbd6ed44:/doc/install/arvbox.html.textile.liquid diff --git a/doc/install/arvbox.html.textile.liquid b/doc/install/arvbox.html.textile.liquid index 2d94d32ac5..3c86721c5b 100644 --- a/doc/install/arvbox.html.textile.liquid +++ b/doc/install/arvbox.html.textile.liquid @@ -14,14 +14,18 @@ Arvbox is a Docker-based self-contained development, demonstration and testing e h2. Quick start
-$ git clone https://github.com/curoverse/arvados.git -$ cd arvados/tools/arvbox/bin +$ curl -O https://git.arvados.org/arvados.git/blob_plain/refs/heads/main:/tools/arvbox/bin/arvbox +$ chmod +x arvbox $ ./arvbox start localdemo +$ ./arvbox root-cert +$ ./arvbox adduser demouser demo@example.com+You will then need to "install the arvbox root certificate":#root-cert . After that, you can now log in to Workbench as @demouser@ with the password you selected. + h2. Requirements -* Linux 3.x+ and Docker 1.9+ +* Linux 3.x+ and Docker 1.10+ * Minimum of 3 GiB of RAM + additional memory to run jobs * Minimum of 3 GiB of disk + storage for actual data @@ -29,32 +33,43 @@ h2. Usage
$ arvbox -Arvados-in-a-box http://arvados.org - -start|run-h2. Install root certificate +h2(#root-cert). 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. @@ -66,18 +81,31 @@ Arvbox creates root certificate to authorize Arvbox services. Installing the ro 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): +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. + +h3. On Debian/Ubuntu: + +[tag] start arvbox container -stop stop arvbox container -restart stop, then run again -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 stop, pull latest image, run -build build arvbox Docker image -reboot stop, build arvbox Docker image, run -rebuild build arvbox Docker image, no layer cache -reset delete arvbox arvados data (be careful!) -destroy delete all arvbox code and data (be careful!) -log tail log of specified service -ls list directories inside arvbox -cat get contents of files inside arvbox -pipe run a bash script piped in from stdin -sv change state of service inside arvbox -clone clone an arvbox +Arvados-in-a-box https://doc.arvados.org/install/arvbox.html + +start|run [tag] start arvbox container +stop stop arvbox container +restart stop, then run again +status print some information about current arvbox +ip print arvbox docker container ip address +host print arvbox published host +shell enter shell as root +ashell enter shell as 'arvbox' +psql enter postgres console +open open arvbox workbench in a web browser +root-cert get copy of root certificate +update stop, pull latest image, run +build build arvbox Docker image +reboot stop, build arvbox Docker image, run +rebuild build arvbox Docker image, no layer cache +checkpoint create database backup +restore restore checkpoint +hotreset reset database and restart API without restarting container +reset delete arvbox arvados data (be careful!) +destroy delete all arvbox code and data (be careful!) +log tail log of specified service +ls list directories inside arvbox +cat get contents of files inside arvbox +pipe run a bash script piped in from stdin +sv + change state of service inside arvbox +clone clone dev arvbox +adduser + add a user login +removeuser + remove user login +listusers list user logins
cp arvbox-root-cert.pem /usr/local/share/ca-certificates/
+/usr/sbin/update-ca-certificates
+
+cp arvbox-root-cert.pem /etc/pki/ca-trust/source/anchors/
+/usr/bin/update-ca-trust
+
+