Newer version available

This quickstart guide is for Foreman 1.5, but the latest version is 3.12.

Quickstart Guide

The Foreman installer is a collection of Puppet modules that installs everything required for a full working Foreman setup. It uses native OS packaging (e.g. RPM and .deb packages) and adds necessary configuration for the complete installation.

Components include the Foreman web UI, Smart Proxy, Passenger (for the puppet master and Foreman itself), and optionally TFTP, DNS and DHCP servers. It is configurable and the Puppet modules can be read or run in “no-op” mode to see what changes it will make.

Supported platforms

  • Red Hat Enterprise Linux 6 and derivatives (CentOS, Scientific Linux)
    • EPEL is required
    • On RHEL 6, additionally the Optional and RHSCL 1.0 repositories/channels:
      • yum-config-manager --enable rhel-6-server-optional-rpms rhel-server-rhscl-6-rpms
      • check the above repositories because the command can silently fail when subscription does not provide it: yum repolist
  • Fedora 19
  • Debian 7 (Wheezy)
  • Debian 6 (Squeeze) (update Puppet from backports)
  • Ubuntu 14.04 (Trusty)
  • Ubuntu 12.04 (Precise)

Other operating systems will need to use alternative installation methods (see the manual).

Installation

The Foreman installer uses Puppet to install Foreman. This guide assumes that you have a newly installed operating system, on which the installer will setup Foreman, a puppet master with Passenger and the Smart Proxy by default.

Downloading the installer

For Red Hat variants, run this (replace ‘el6’ with ‘f19’ if appropriate):

yum -y install http://yum.theforeman.org/releases/1.5/el6/x86_64/foreman-release.rpm
yum -y install foreman-installer

For Debian variants, run this (replace ‘wheezy’ with ‘trusty’ if on Ubuntu 14.04, ‘precise’ if on Ubuntu 12.04, or ‘squeeze’ for Debian 6):

echo "deb http://deb.theforeman.org/ wheezy 1.5" > /etc/apt/sources.list.d/foreman.list
echo "deb http://deb.theforeman.org/ plugins 1.5" >> /etc/apt/sources.list.d/foreman.list
wget -q http://deb.theforeman.org/pubkey.gpg -O- | apt-key add -
apt-get update && apt-get install foreman-installer

Running the installer

The installation run is non-interactive, but the configuration can be customized by supplying any of the options listed in foreman-installer --help, or by running foreman-installer -i for interactive mode. More examples are given in the Installation Options section. Adding -v will disable the progress bar and display all changes. To run the installer, execute:

foreman-installer

After it completes, Foreman will be accessible at https://fqdn/ with a default username/password of “admin” and “changeme”.

More quickstart resources…

Continue reading the quickstart guide in the manual:

Or view the quickstart screencasts:

Additional reading…

Foreman 3.12.0 has been released! Follow the quick start to install it.

Foreman 3.11.2 has been released! Follow the quick start to install it.