Installation guide


You need to have a fully functional Vulture-OS system, installed either with the OVA/ESX image or with the Vulture install script (See: Getting Started).

Once you've got Vulture-OS running, log in as 'vlt-adm'. WARNING: vlt-adm account do not have any password at this stage. A "secure" random password will be generated during the bootstrap process (see below).

AFTER INSTALLATION, PLEASE READ the Hardening GUIDE and adjust pf firewall configuration as it is permissive by default !

Bootstraping Vulture

During this step, Vulture will be downloaded and installed on top of Vulture-OS.


Vulture requires an Internet connection to download FreeBSD & Vulture's updates. You can use an HTTP Proxy if needed.
Please note that the VultureProject website is not (yet) IPv6 ready - So you will have to use an IPv6 enabled HTTP Proxy if you want to bootstrap Vulture from an IPv6 network.

Let's go !

Launch the bootstrap process with sudo /home/vlt-gui/env/bin/python /var/bootstrap/
You can also use a config file to bootstrap Vulture. This file is located at: /var/bootstrap/vulture_conf.json

    "ready"          : "",          Y
    "confirm_license": "",          OK
    "keymap"         : "",          ex: fr.iso.acc.kbd
    "hostname"       : "",          Hostname of the node
    "proxy"          : "",          If proxy, set the url (without http/https://)
    "interface"      : 0,           Interface to configure (0, 1, 2)
    "ipv4_configure" : "",          Configure IPv4 ? Y/N
    "ipv4_dhcp"      : "",          IPv4 DHCP Y/N
    "ipv6_configure" : "",          Configure IPv6 ? Y/N
    "network_configuration": {
        "inet"      : "",           IPv4 Address
        "netmask"   : "",           IPv4 Netmask
        "gateway"   : "",           IPv4 Gateway
        "nameserver": "",           DNS Nameserver
        "inet6"     : "",           IPv6 Address
        "gateway6"  : ""            IPv6 Gateway
    "ntp"           : "",           NTP (default, blank)
    "vulture_config": 0,            0: Master Node; 1: Node
    "node_config"   : {
        "primary_hostname": "",     Primary hostname of the cluster
        "primary_ip"      : "",     Primary IP address
        "cluster_password": ""      Node password to join cluster
    "email_address"   : "",         Email address for registration key
    "registration_key": "",         Registration key: will not be used.

    "pki"    : {                    Ex:
        "country"          : "",    FR
        "state"            : "",    France
        "city"             : "",    Lille
        "organization"     : "",    VultureProject
        "organization_unit": ""     VultureProject
    "admin": {
        "username"  : "",           admin
        "password"  : "",           *******
        "repassword": ""            *******

All value are optional. If a value is not filled, the bootstrap will ask you the value. To launch the bootstrap with the configuration file:
/var/bootstrap/ --config /var/bootstrap/vulture_conf.json

During the process Vulture will configure the system and install Vulture
You will be guided through several steps:

  • Keyboard configuration
  • Network and proxy configuration
  • Choice of the installation mode:
    • Create a new Vulture cluster
    • Join an existing one
  • Vulture registration (a valid email address is required to receive an activation code)
  • Vulture Downloading
  • Internal PKI initialization
  • "GUI admin" user & password definition
  • "vlt-adm" password randomization
  • Start of Vulture processes

Installation process can take several minutes, depending of your internet connection speed.
Be careful during PKI initialization: The country field needs to be on 2 characters, "FR" for example.

  • IMPORTANT: If you are using ZFS as filesystem, you need to add zfs_enable="YES" in /etc/rc.conf
  • IMPORTANT: Vulture needs to be rebooted after bootstrap

When everything is good, Vulture GUI should be accessible at https://your_ip_adress:8000.

The root account is not allowed to login over SSH. Please log in with 'vlt-adm' and become root with sudo csh when needed. During normal operation, SSH or console access is not needed, as a lot of things are available through the Vulture GUI.

Vulture GUI

Vulture is fully manageable from the Web GUI. It is listening on TCP port 8000 by default.
Vulture GUI requires a TLSv1.1 compatible web browser. Best experience with Firefox!

You can login into the GUI with the username and password defined during the bootstrap process:

Vulture GUI