Merge branch 'master' into 6473-fetch-events-starting-at
[arvados.git] / doc / install / install-shell-server.html.textile.liquid
1 ---
2 layout: default
3 navsection: installguide
4 title: Install a shell server
5 ...
6
7 There is nothing inherently special about an Arvados shell server. It is just a GNU/Linux machine with Arvados utilites and SDKs installed. For optimal performance, the Arvados shell server should be on the same LAN as the Arvados cluster, but that is not required.
8
9 h2. Install API tokens
10
11 Please follow the "API token guide":{{site.baseurl}}/user/reference/api-tokens.html to get API tokens for your user and install them on your shell server. We will use those tokens to test the SDKs as we install them.
12
13 h2. Install the Ruby SDK and utilities
14
15 If you're using RVM:
16
17 <notextile>
18 <pre><code>~$ <span class="userinput">sudo rvm-exec gem install arvados-cli</span>
19 </code></pre>
20 </notextile>
21
22 If you're not using RVM:
23
24 <notextile>
25 <pre><code>~$ <span class="userinput">sudo gem install arvados-cli</span>
26 </code></pre>
27 </notextile>
28
29 h2. Install the Python SDK and utilities
30
31 On Debian-based systems:
32
33 <notextile>
34 <pre><code>~$ <span class="userinput">sudo apt-get install python-arvados-python-client python-arvados-fuse</span>
35 </code></pre>
36 </notextile>
37
38 On Red Hat-based systems:
39
40 <notextile>
41 <pre><code>~$ <span class="userinput">sudo yum install python27-python-arvados-python-client python27-python-arvados-fuse</span>
42 </code></pre>
43 </notextile>
44
45 {% include 'note_python27_sc' %}
46
47 h2. Update Git Config
48
49 Configure git to use the ARVADOS_API_TOKEN environment variable to authenticate to arv-git-httpd.
50
51 Execute the following commands to setup the needed configuration.
52
53 <notextile>
54 <pre>
55 <code>~$ <span class="userinput">git config 'credential.https://git.{{ site.arvados_api_host }}/.username' none</span></code>
56 <code>~$ <span class="userinput">git config 'credential.https://git.{{ site.arvados_api_host }}/.helper' '!cred(){ cat >/dev/null; if [ "$1" = get ]; then echo password=$ARVADOS_API_TOKEN; fi; };cred'</span></code>
57 </pre>
58 </notextile>