root/README.md @ develop
| 2b94cf6e | Ewoud Kohl van Wijngaarden | [Smart Proxy](https://projects.theforeman.org/projects/smart-proxy/wiki) is a free open source project that provides restful API to subsystems such as DNS, DHCP, etc, for higher level orchestration tools such as [Foreman](https://github.com/theforeman/foreman).
|
|
| c08eb9a8 | Dmitri Dolguikh | ||
| 2b94cf6e | Ewoud Kohl van Wijngaarden | * Issues: [Redmine](https://projects.theforeman.org/projects/smart-proxy/issues)
|
|
* Wiki: [Foreman wiki](https://projects.theforeman.org/projects/smart-proxy/wiki)
|
|||
| 7804b1e2 | Ewoud Kohl van Wijngaarden | * Community and support: We have a [forum](https://community.theforeman.org) and use [Libera](https://libera.chat) IRC channels
|
|
| c08eb9a8 | Dmitri Dolguikh | * #theforeman for general support
|
|
* #theforeman-dev for development chat
|
|||
# Supported Modules
|
|||
Currently Supported modules:
|
|||
* BMC - BMC management of devices supported by freeipmi and ipmitool
|
|||
* DHCP - ISC DHCP and MS DHCP Servers
|
|||
* DNS - Bind and MS DNS Servers
|
|||
| 6983107b | Ewoud Kohl van Wijngaarden | * Puppet - Puppetserver 6 or 7
|
|
| c08eb9a8 | Dmitri Dolguikh | * Puppet CA - Manage certificate signing, cleaning and autosign on a Puppet CA server
|
|
* Realm - Manage host registration to a realm (e.g. FreeIPA)
|
|||
* TFTP - any UNIX based tftp server
|
|||
| 4285fc0f | Lukas Zapletal | * Facts - module to gather facts from facter (used only on discovered nodes)
|
|
* HTTPBoot - endpoint exposing a (TFTP) directory via HTTP(s) for UEFI HTTP booting
|
|||
* Logs - log buffer of proxy logs for easier troubleshooting
|
|||
* Templates - unattended Foreman endpoint proxy
|
|||
| c08eb9a8 | Dmitri Dolguikh | ||
# Installation
|
|||
| 2b94cf6e | Ewoud Kohl van Wijngaarden | Read the [Smart Proxy Installation section](https://theforeman.org/manuals/latest/index.html#4.3.1SmartProxyInstallation) of the manual.
|
|
| c08eb9a8 | Dmitri Dolguikh | ||
# Configuration
|
|||
| 2b94cf6e | Ewoud Kohl van Wijngaarden | Read the [Smart Proxy Settings section](https://theforeman.org/manuals/latest/index.html#4.3.2SmartProxySettings) of the manual.
|
|
| c08eb9a8 | Dmitri Dolguikh | ||
# For Developers
|
|||
| 2b94cf6e | Ewoud Kohl van Wijngaarden | * [API Reference](https://projects.theforeman.org/projects/smart-proxy/wiki/API)
|
|
| 802ce04a | Peter Bittner | * Smart Proxy Plugin development [how-to](https://projects.theforeman.org/projects/foreman/wiki/How_to_Create_a_Smart-Proxy_Plugin)
|
|
| c08eb9a8 | Dmitri Dolguikh | ||
# Special thanks
|
|||
| 2b94cf6e | Ewoud Kohl van Wijngaarden | The original author of this project is [Ohad Levy](https://github.com/ohadlevy). You can find a more thorough list of people who have contributed to this project at some point in [Contributors](Contributors).
|
|
| c08eb9a8 | Dmitri Dolguikh | ||
# License
|
|||
| af410163 | Dmitri Dolguikh | See [LICENSE](LICENSE) file.
|