Update the godoc path for keep-web in our documentation.
[arvados.git] / doc / install / automatic.html.textile.liquid
1 ---
2 layout: default
3 navsection: installguide
4 title: Automatic single-node install
5 ...
6 {% comment %}
7 Copyright (C) The Arvados Authors. All rights reserved.
8
9 SPDX-License-Identifier: CC-BY-SA-3.0
10 {% endcomment %}
11
12 {% include 'notebox_begin' %}
13 This installation method is not fully implemented, which is why this page is not yet listed in the "table of installation options":{{site.baseurl}}/install/index.html or in the left nav.
14 {% include 'notebox_end' %}
15
16 This method sets up a new Arvados cluster using a single host/VM. It is the easiest way to get a new production cluster up and running.
17
18 A single-node installation supports all Arvados functionality at small scale. Substantial workloads will require additional nodes and configuration steps.
19
20 h2. Prerequisites
21
22 You will need:
23 * a server host running Debian 10 (buster).
24 * a unique 5-character ID like @x9999@ for your cluster (first character should be @[a-w]@ for a long-lived / production cluster; all characters are @[a-z0-9]@).
25 * a DNS name like @x9999.example.com@ that resolves to your server host (or a load balancer / proxy that passes HTTP and HTTPS requests through to your server host).
26 * a Google account (use it in place of <code>example@gmail.com.example</code> in the instructions below).
27
28 h2. Initialize the cluster
29
30 <pre>
31 # echo > /etc/apt/sources.list.d/arvados.list "deb http://apt.arvados.org/buster buster main"
32 # apt-get update
33 # apt-get install arvados-server-easy
34 # arvados-server init -type production -cluster-id x9999 -controller-address x9999.example.com -admin-email example@gmail.com.example
35 </pre>
36
37 When the "init" command is finished, navigate to the link shown in the terminal (e.g., @https://x9999.example.com/?api_token=zzzzzzzzzzzzzzzzzzzzzz@). This will log you in to your admin account.
38
39 h2. Enable login
40
41 Follow the instructions to "set up Google login":{{site.baseurl}}/install/setup-login.html or another authentication option.
42
43 After updating your configuration file (@/etc/arvados/config.yml@), restart the server to make your changes take effect:
44
45 <pre>
46 # systemctl restart arvados-server
47 </pre>