Ruby HTML JavaScript Python CSS Shell
Permalink
Failed to load latest commit information.
.storybook fixes #20193 - upgrade storybook to 3.1 Jul 5, 2017
.tx fixes #8874 - rework POT/PO updates for gettext 3's edit.po Feb 3, 2016
__mocks__ Fixes #13424 - c3 patternfly react implementation Oct 9, 2016
app Fixes #21200 - gracefully handle long welcome text Oct 23, 2017
bin Fixes #18618 - Use Dynflow as an ActiveJob backend Jul 20, 2017
bundler.d fixes #20878 - vmware clone: rewrite boot order Sep 20, 2017
config Fixes #21180 - Enable adding 3rd party libraries from plugins Oct 19, 2017
db Fixes #21342 - fix core roles seeding Oct 19, 2017
extras Fixes #1556, #11615 - Remove puppet rdoc support Nov 28, 2016
lib Fixes #21342 - fix core roles seeding Oct 19, 2017
locale i18n - extracting new, pulling from tx Aug 28, 2017
log WIP rails3 migration Nov 28, 2011
man refs #17044 - update foreman-debug man page for -s option change Nov 7, 2016
public Fixes #13936 - Drop support for legacy browsers Sep 15, 2016
script Fixes #21180 - Enable adding 3rd party libraries from plugins Oct 19, 2017
test Fixes #21342 - fix core roles seeding Oct 19, 2017
vendor/assets fixes #14178 - introduce patternfly toast notifications May 8, 2017
webpack Fixes #21202 - Add close button to notifications drawer Oct 23, 2017
.babelrc fixes #20228 - fix jest testing Jul 9, 2017
.eslintignore Fixes #16074 - Adds BIND variable to startup process Sep 14, 2016
.eslintrc Fixes #13424 - c3 patternfly react implementation Oct 9, 2016
.gitignore Fixes #21180 - Enable adding 3rd party libraries from plugins Oct 19, 2017
.hound.yml fixes #20275 - add css linter support Jul 12, 2017
.mention-bot Refs #17602 - correct typo in mention-bot config Dec 27, 2016
.rubocop.yml Fixes #19912 - Allow all styles of word arrays Sep 18, 2017
.rubocop_todo.yml Fixes #19912 - Allow all styles of word arrays Sep 18, 2017
.stylelintrc fixes #20275 - add css linter support Jul 12, 2017
.travis.yml Fixes #21180 - Enable adding 3rd party libraries from plugins Oct 19, 2017
CHANGELOG Bump version to 1.17-develop Aug 28, 2017
CONTRIBUTING.md Fixes #16139 - Add link to code contribution in CONTRIBUTING.md Aug 17, 2016
Contributors Bump version to 1.17-develop Aug 28, 2017
Gemfile refs #20201: update dependency to rest-client Oct 11, 2017
LICENSE Fixes #19490 - Remove Apache License May 10, 2017
Procfile Fixes #16160 - added start-foreman-dev helper Jul 20, 2017
README.md Fixes #18425 - Update README screenshots and links Feb 10, 2017
Rakefile fixes #19050 - add Ruby on Rails 5.0 support Jul 5, 2017
Rakefile.dist Refs #7719 - explicitly create .ssh dir in home Oct 21, 2014
VERSION Bump version to 1.17-develop Aug 28, 2017
config.ru fixes #1463 - let Foreman run on a sub path Jul 2, 2012
package.json Fixes #21160: Upgrade to React@16 Oct 23, 2017

README.md

Foreman

Build Status Code Climate Issue Stats Support IRC channel

Foreman is a free open source project that gives you the power to easily automate repetitive tasks, quickly deploy applications, and proactively manage your servers lifecyle, on-premises or in the cloud.

From provisioning and configuration to orchestration and monitoring, Foreman integrates with your existing infrastructure to make operations easier.

Using Puppet, Ansible, Chef, Salt and Foreman's smart proxy architecture, you can easily automate repetitive tasks, quickly deploy applications, and proactively manage change, both on-premise with VMs and bare-metal or in the cloud.

Foreman provides comprehensive, interaction facilities including a web frontend, CLI and RESTful API which enables you to build higher level business logic on top of a solid foundation.

Foreman is a mature project, deployed in many organizations, managing from 10s to 10000s of servers. It is used in distributions such as RDO and RHOS (Red Hat OpenStack distribution) and has an extensive library of plugins.

Features

  • Automate your mixed infrastructure to make operations enjoyable
  • Discover, provision and upgrade your entire bare-metal infrastructure
  • Create and manage instances across private and public clouds
  • Group your hosts and manage them in bulk, regardless of location
  • Review historical changes for auditing or troubleshooting
  • Extend as needed via a robust plugin architecture
  • Automatically build images (on each platform) per system definition to optimize deployment
  • LDAP authentication and RBAC authorization to your infrastructure
  • and so much more

Screenshots

Hosts list New host EC2 Provisioning templates Subnets Compute Resource Edit Puppet class Reports Statistics Partition tables Installation media

Installation

Read the quickstart section of the manual. If you know your setup has some specific needs, read the installation scenarios section.

Documentation

Our main documentation reference is the Foreman manual. If you find some gaps you would like to fill in the manual, please contribute in this repo.

API

We document our API using apipie.The API chapter has more information about accessing the API and the layout of requests and responses. Also see the reference documentation available on our website, or via your own Foreman installation by appending /apidoc to the URL to see the API routes available.

Plugins

Plugins are tools to extend and modify the functionality of Foreman. They are implemented as Rails engines that are packaged as gems and thus easily installed into Foreman.

The plugins page lists all available plugins and has more information about how to install and develop them.

How to contribute?

Generally, follow the Foreman guidelines. For code-related contributions, fork this project and send a pull request with all changes. Some things to keep in mind:

  • Follow the rules about commit message style and create a Redmine issue. Doing this right will help reviewers to get your contribution merged faster.
  • We have a development handbook to help developers understand how Foreman developers code.
  • Rubocop will analyze your code, you can run it locally with rake rubocop.
  • All of our pull requests run the full test suite in our Jenkins CI system. Please include tests in your pull requests for any additions or changes in functionality

Media

We keep a repository of talks, tutorials, articles about everything in the Foreman ecosystem in the media section of our web. If you want to get yours published, just submit a pull request to theforeman.org repository

Special thanks

The original authors of this project are Ohad Levy and Paul Kelly. You can find a more thorough list of people who have contributed to this project at some point in Contributors.

License

See LICENSE file.