foreman/README.md @ develop
| 9524694b | Daniel Lobato García | 
|
|
| 5563217a | Ohad Levy | ||
| f862a931 | Tomer Brisker | [](https://ci.theforeman.org/job/test_foreman-develop-source-release/)
|
|
| 9524694b | Daniel Lobato García | [](https://codeclimate.com/github/theforeman/foreman)
|
|
| 254f2279 | Avi Sharvit | [](https://coveralls.io/github/theforeman/foreman?branch=develop)
|
|
| 3256e139 | Amit Upadhye | [](https://kiwiirc.com/client/irc.libera.chat/?#theforeman)
|
|
| 9524694b | Daniel Lobato García | ||
| 1874c27a | MariaAga | [Foreman](https://theforeman.org) is a free open source project that gives you the power to easily **automate repetitive tasks**, quickly **deploy applications**, and proactively **manage your servers life cycle**, on-premises or in the cloud.
|
|
| 9524694b | Daniel Lobato García | ||
From **provisioning** and **configuration** to **orchestration** and **monitoring**, Foreman integrates with your existing infrastructure to make operations easier.
|
|||
| 15fc2d94 | Daniel Lobato Garcia | * Website: [theforeman.org](https://theforeman.org)
|
|
| 5d3c04db | Michael Moll | * ServerFault tag: [Foreman](https://serverfault.com/questions/tagged/foreman)
|
|
* Issues: [Redmine](https://projects.theforeman.org/issues)
|
|||
* Wiki: [Foreman wiki](https://projects.theforeman.org/projects/foreman/wiki/About)
|
|||
| 3750d2ce | Evgeni Golov | * Forum: [Foreman Community](https://community.theforeman.org)
|
|
* Chat: We use [Libera.Chat](https://libera.chat) IRC channels
|
|||
| 9524694b | Daniel Lobato García | * #theforeman for general support
|
|
* #theforeman-dev for development chat
|
|||
| 15fc2d94 | Daniel Lobato Garcia | Using [Puppet](https://www.theforeman.org/manuals/latest/#4.2ManagingPuppet), [Ansible](https://theforeman.org/plugins/foreman_ansible/), [Chef](https://theforeman.org/plugins/foreman_chef/), [Salt](https://theforeman.org/plugins/foreman_salt/) and Foreman's [smart proxy](https://www.theforeman.org/manuals/latest/#4.3SmartProxies) 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.
|
|
| 9524694b | Daniel Lobato García | ||
| 15fc2d94 | Daniel Lobato Garcia | Foreman provides comprehensive, interaction facilities including a **web frontend**, [**CLI**](https://theforeman.org/manuals/latest/index.html#4.5CommandLineInterface) and [**RESTful API**](https://theforeman.org/documentation.html) which enables you to build higher level business logic on top of a solid foundation.
|
|
| 9524694b | Daniel Lobato García | ||
| 5d3c04db | Michael Moll | Foreman is a mature project, deployed in [many organizations](https://projects.theforeman.org/projects/foreman/wiki/Who_Uses_Foreman), 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](https://projects.theforeman.org/projects/foreman/wiki/List_of_Plugins).
|
|
| 9524694b | Daniel Lobato García | ||
# 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
|
|||
| 15fc2d94 | Daniel Lobato Garcia | * and so [much more](https://theforeman.org/documentation.html)
|
|
| 9524694b | Daniel Lobato García | ||
# Screenshots
|
|||
| 6cfb0ab4 | nofaralfasi | 
|
|
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
| 9524694b | Daniel Lobato García | ||
# Installation
|
|||
| 15fc2d94 | Daniel Lobato Garcia | Read the [quickstart section](https://theforeman.org/manuals/latest/quickstart_guide.html#QuickstartGuide) of the manual. If you know your setup has some specific needs, read the [installation scenarios section](https://theforeman.org/manuals/latest/#3.2.3InstallationScenarios).
|
|
| 9524694b | Daniel Lobato García | ||
# Documentation
|
|||
| 15fc2d94 | Daniel Lobato Garcia | Our main documentation reference is the [Foreman manual](https://theforeman.org/manuals/latest/). If you find some gaps you would like to fill in the manual, please contribute in [this repo](https://github.com/theforeman/theforeman.org).
|
|
| 9524694b | Daniel Lobato García | ||
## API
|
|||
| 15fc2d94 | Daniel Lobato Garcia | We document our API using [apipie](https://github.com/Apipie/apipie-rails).The [API chapter](https://theforeman.org/manuals/latest/index.html#5.1API) has more information about accessing the API and the layout of requests and responses. Also see the [reference documentation](https://theforeman.org/api/) available on our website, or via your own Foreman installation by appending `/apidoc` to the URL to see the API routes available.
|
|
| 9524694b | Daniel Lobato García | ||
# Plugins
|
|||
| 15fc2d94 | Daniel Lobato Garcia | 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.
|
|
| 9524694b | Daniel Lobato García | ||
| 15fc2d94 | Daniel Lobato Garcia | The [plugins page](https://theforeman.org/plugins/) lists all available plugins and has more information about how to install and develop them.
|
|
| 9524694b | Daniel Lobato García | ||
| 8977b4fa | sandstrom | # Similarly Named Project
|
|
There is a similarly named project on Github called [foreman](https://github.com/ddollar/foreman) (a CLI tool for running processes).
|
|||
We've left a note about it here, to help people in case that's the one they're looking for, but ended up here.
|
|||
| 9524694b | Daniel Lobato García | # How to contribute?
|
|
| 15fc2d94 | Daniel Lobato Garcia | Generally, follow the [Foreman guidelines](https://theforeman.org/contribute.html). For code-related contributions, fork this project and send a pull request with all changes. Some things to keep in mind:
|
|
* [Follow the rules](https://theforeman.org/contribute.html#SubmitPatches) 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](https://theforeman.org/handbook.html) to help developers understand how Foreman developers code.
|
|||
| 9524694b | Daniel Lobato García | * [Rubocop](https://github.com/bbatsov/rubocop) will analyze your code, you can run it locally with `rake rubocop`.
|
|
| cd640b08 | Lior Keren | * All of our pull requests run the full test suite in our [Jenkins CI system](https://ci.theforeman.org/). Please include tests in your pull requests for any additions or changes in functionality.
|
|
* Please have a look at [Contributing.md](https://github.com/theforeman/foreman/blob/develop/CONTRIBUTING.md) for more information.
|
|||
| 9524694b | Daniel Lobato García | ||
# Media
|
|||
| 15fc2d94 | Daniel Lobato Garcia | We keep a repository of talks, tutorials, articles about everything in the Foreman ecosystem in the [media section](https://theforeman.org/media.html) of our web. If you want to get yours published, just submit a pull request to [theforeman.org repository](https://github.com/theforeman/theforeman.org)
|
|
| 9524694b | Daniel Lobato García | ||
| 0627e5b2 | Daniel Lobato | # Special thanks
|
|
| 5563217a | Ohad Levy | ||
| 15fc2d94 | Daniel Lobato Garcia | The original authors of this project are [Ohad Levy](https://github.com/ohadlevy) and [Paul Kelly](https://github.com/pikelly).
|
|
| 0627e5b2 | Daniel Lobato | You can find a more thorough list of people who have contributed to this project at some point in [Contributors](Contributors).
|
|
| 5563217a | Ohad Levy | ||
| 08bc2344 | Andrea Kao | # Licensing
|
|
| 5563217a | Ohad Levy | ||
| 0627e5b2 | Daniel Lobato | See [LICENSE](LICENSE) file.
|
|
| 08bc2344 | Andrea Kao | ||
The Foreman repository/package is licensed under the GNU GPL v3 or newer, with some exceptions.
|
|||
| 3b422976 | Tomer Brisker | Copyright (c) 2009-2020 to Ohad Levy, Paul Kelly and their respective owners.
|
|
| 08bc2344 | Andrea Kao | ||
All copyright holders for the Foreman project are in the separate file called Contributors.
|
|||
Except where specified below, this program and entire repository is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.
|
|||
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
|||
You should have received a copy of the GNU General Public License along with this program. If not, see [GNU licenses](http://www.gnu.org/licenses/).
|
|||
The following files and directories are exceptions:
|
|||
* app/views/unattended/ztp/provision.erb is (c) 2013, Juniper Networks under 2-clause BSD license.
|
|||
* lib/tasks/convert.rake is (c) 2008, Matson Systems, Inc. under Revised BSD license.
|
|||
* vendor/assets/fonts/ is (c) 2011-2016, Red Hat Inc. under SIL Open Font License v1.1 or LGPL v2.1 licenses.
|
|||
* vendor/assets/javascripts/jquery.flot.axislabels.js is (c) 2010 Xuan Luo under MIT license.
|
|||
* app/assets/images/RancherOS.png is (c) 2018 Rancher Labs, Inc.
|
|||
All rights reserved.
|
|||
The [LICENSE](LICENSE) file contains the full text of the GNU GPL v3 license, along with the text for all additional licenses referenced above.
|