Newer version available
This quickstart guide is for Foreman 3.11, but the latest version is 3.12.
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, a Puppet server, 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.
The installation will require 4GB of memory, see System Requirements for more information.
The Foreman packages and installer are tested on AlmaLinux 8, AlmaLinux 9, CentOS Stream 8 and CentOS Stream 9, but other RHEL derivatives can work because they’re similar. Sometimes additional work may be needed. For any queries for these platforms raise a question in discourse support section
The Foreman installer uses Puppet (6 or later required) to install Foreman. This guide assumes that you have a newly installed operating system, on which the installer will setup Foreman, a Puppet server, and the Smart Proxy by default. It’s not advisable to follow the steps below on an existing system, since the installer will affect the configuration of several components.
To provide specific installation instructions, please select your operating system:
Enable Puppet's 7.x repository:
sudo dnf -y install https://yum.puppet.com/puppet7-release-el-8.noarch.rpmEnable Puppet's 7.x repository:
sudo dnf -y install https://yum.puppet.com/puppet7-release-el-9.noarch.rpmEnable the Foreman repositories:
sudo dnf -y install https://yum.theforeman.org/releases/3.11/el8/x86_64/foreman-release.rpmEnable the Foreman repositories:
sudo dnf -y install https://yum.theforeman.org/releases/3.11/el9/x86_64/foreman-release.rpmEnable the Foreman module:
sudo dnf -y module enable foreman:el8Enable Puppet's 7.x repository:
sudo apt-get -y install ca-certificates
cd /tmp && wget https://apt.puppet.com/puppet7-release-bullseye.deb
sudo apt-get install /tmp/puppet7-release-bullseye.debEnable the Foreman repositories:
sudo wget https://deb.theforeman.org/foreman.asc -O /etc/apt/trusted.gpg.d/foreman.asc
echo "deb https://deb.theforeman.org/ bullseye 3.11" | sudo tee /etc/apt/sources.list.d/foreman.list
echo "deb https://deb.theforeman.org/ plugins 3.11" | sudo tee -a /etc/apt/sources.list.d/foreman.listEnable Puppet's 7.x repository:
sudo apt-get -y install ca-certificates
cd /tmp && wget https://apt.puppet.com/puppet7-release-focal.deb
sudo apt-get install /tmp/puppet7-release-focal.debEnable the Foreman repositories:
sudo wget https://deb.theforeman.org/foreman.asc -O /etc/apt/trusted.gpg.d/foreman.asc
echo "deb https://deb.theforeman.org/ focal 3.11" | sudo tee /etc/apt/sources.list.d/foreman.list
echo "deb https://deb.theforeman.org/ plugins 3.11" | sudo tee -a /etc/apt/sources.list.d/foreman.listEnable Puppet's 8.x repository:
sudo apt-get -y install ca-certificates
cd /tmp && wget https://apt.puppet.com/puppet8-release-bookworm.deb
sudo apt-get install /tmp/puppet8-release-bookworm.debEnable the Foreman repositories:
sudo wget https://deb.theforeman.org/foreman.asc -O /etc/apt/trusted.gpg.d/foreman.asc
echo "deb https://deb.theforeman.org/ bookworm 3.11" | sudo tee /etc/apt/sources.list.d/foreman.list
echo "deb https://deb.theforeman.org/ plugins 3.11" | sudo tee -a /etc/apt/sources.list.d/foreman.listEnable Puppet's 7.x repository:
sudo apt-get -y install ca-certificates
cd /tmp && wget https://apt.puppet.com/puppet7-release-jammy.deb
sudo apt-get install /tmp/puppet7-release-jammy.debEnable the Foreman repositories:
sudo wget https://deb.theforeman.org/foreman.asc -O /etc/apt/trusted.gpg.d/foreman.asc
echo "deb https://deb.theforeman.org/ jammy 3.11" | sudo tee /etc/apt/sources.list.d/foreman.list
echo "deb https://deb.theforeman.org/ plugins 3.11" | sudo tee -a /etc/apt/sources.list.d/foreman.listsudo dnf -y install foreman-installersudo apt-get update && sudo apt-get -y install foreman-installerping $(hostname -f) shows the real IP address, not 127.0.1.1. Change or remove this entry from /etc/hosts if present.
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:
sudo foreman-installerAfter it completes, the installer will print some details about where to find Foreman and the Smart Proxy. Output should be similar to this:
* Foreman is running at https://theforeman.example.com
Initial credentials are admin / 3ekw5xtyXCoXxS29
* Foreman Proxy is running at https://theforeman.example.com:8443
The full log is at /var/log/foreman-installer/foreman-installer.logOver the last year, Foreman community members have been open-sourcing Red Hat documentation to make more comprehensive guides available to Foreman users. At the moment, the following guides have been migrated to a work-in-progress Foreman and Katello documentation site. This project is not yet complete, but you might find useful information in some of the following guides:
Continue reading the quickstart guide in the manual:
Or view the quickstart screencasts:
Foreman 3.12.1 has been released! Follow the quick start to install it.
Foreman 3.11.5 has been released! Follow the quick start to install it.