Docs · 1.0

First-time setup

After installation there are three things to do in the web page: set the admin password, create a storage pool and choose the time zone. Once those are done you can create virtual machines.

1. Open the web page

Open the address shown on the host's screen in a browser, for example https://192.168.1.10/.

keelOS uses a certificate it generated itself, so the browser warns "Your connection is not private" or "invalid certificate" the first time. This is normal: choose Advanced → Proceed. The same host will not change its certificate later.

2. Set the admin password

A freshly installed host has no admin password yet, so the web page shows Set the admin password:

1. Enter a password (at least 8 characters) and type it again in Again.
2. Click Set and log in.

Whoever sets the password now is the administrator of this host. This password is also root's password: use it to log in on the host's console and over ssh.

• The login stays in this browser for 30 days (counted from the last use).
• Changing the password: not possible in the 1.0 web page yet; use passwd on the console or over ssh, and the web login uses the new password too.
• Starting over: run keel admin reset on the host's local console (it does not work over ssh). It clears the admin password and all tokens, and whoever opens the web page next sets a new password. See Accounts, tokens and permissions.

At the top right of the page you can switch the language (中文, English, 日本語) and the dark or light theme.

3. Create a storage pool

Virtual machine disks, snapshots and ISOs are stored in a storage pool; without one you cannot create virtual machines. After you log in, the Overview page reminds you that there is no storage pool yet.

1. Open Configuration → Storage.
2. In Make the pool zones, pick the space to use: - The free space behind the boot partition: choose this on a machine with a single disk. - Whole disks: choose other disks. A whole disk you select is wiped. - You can choose both at the same time.
3. If you picked more than one, choose the Layout: - single disk: one disk. - mirror: two (or more) disks hold the same data; you lose nothing if one fails. - raidz (one disk may fail), raidz2 (two disks may fail): three or more disks.
4. After you confirm, the pool is created in a few seconds.

Later you can add a disk to a mirror, create a second pool, or replace a disk; see Storage.

Note: if you plan to pass whole disks through to a NAS virtual machine, do not put those disks in the storage pool.

4. Choose the time zone

Open System → Time, click the place nearest to this machine on the world map or choose it from the list, then Save.

The time zone affects the times shown in the web page and the clock of virtual machines that use local time (Windows) when they start. The host system itself and the logs use UTC. Changing the time zone does not affect running virtual machines; a Windows virtual machine uses the new time zone the next time it starts.

5. Take a look at the Overview

The Overview page shows the state of this host: the version and the running slot, CPU, memory, storage pools, network ports, addresses, and things that need attention (pool errors, memory errors and so on).

Optional extras

These are not required; look at them when you need them:

• Fixed address: by default the host gets its address by DHCP. For a fixed address, or if the management port must use a VLAN, see Network.
• Tokens: to reach this host's API from scripts, the command line or other programs, create a token under System → Tokens; see Accounts, tokens and permissions.
• Command line from another computer: ssh is enabled on the host; log in as root with the admin password. See The keel command line.

Next step: Creating your first virtual machine.