Foreman » Smart Proxy

{{toc}}

h1. Installation instructions

h2. Source code

You can get the latest stable code from "GitHub":https://github.com/theforeman/smart-proxy ("via git":git://github.com/theforeman/smart-proxy.git).

<pre>

git clone git://github.com/theforeman/smart-proxy.git

</pre>

h2. RPM

You can get a the stable rpm "Here":http://yum.theforeman.org/

h2. Debian/Ubuntu packages

We provide packages for Smart-Proxy for the following Debian-based Linux distributions:

* Debian Linux 6.0 (Squeeze)

* Ubuntu Linux 12.04 (Precise Pangolin)

These packages may also work on (let us know if they do :P):

* Debian Linux 5.0 (Lenny), see notes below

* Ubuntu Linux 10.04 (Lucid Lynx)

* Ubuntu Linux 10.10 (Maverick Meerkat)

* Ubuntu Linux 11.04 (Natty Narwhal)

Add one (and only one) of the following package sources to your @/etc/apt/sources.list@ or create an appropriate file in @/etc/apt/sources.list.d/@:

<pre>

# Stable packages

# Debian Squeeze

deb http://deb.theforeman.org/ squeeze stable

# Ubuntu Precise

deb http://deb.theforeman.org/ precise stable

# Nightly builds. Beware: HERE BE DRAGONS

# Debian Squeeze

deb http://deb.theforeman.org/ squeeze nightly

# Ubuntu Precise

deb http://deb.theforeman.org/ precise nightly

</pre>

The public key for "secure APT":http://wiki.debian.org/SecureApt can be downloaded "here":http://deb.theforeman.org/foreman.asc

You can add the key after its download with

<pre># Debian Linux (as root)

apt-key add foreman.asc

# Ubuntu Linux (as normal user)

sudo apt-key add foreman.asc

</pre>

or combine downloading and registering:

<pre># Debian Linux (as root)

wget -q http://deb.theforeman.org/foreman.asc -O- | apt-key add -

# Ubuntu Linux (as normal user)

wget -q http://deb.theforeman.org/foreman.asc -O- | sudo apt-key add -

</pre>

The key fingerprint is

<pre>

1DCB 15D1 2CA1 40EE F494  7E57 66CF 053F E775 FF07

Foreman Archive Signing Key <packages@theforeman.org>

</pre>

To install Smart-Proxy, run

<pre># Debian Linux (as root)

apt-get update

apt-get install foreman-proxy

# Ubuntu Linux (as normal user)

sudo aptitude update

sudo aptitude install foreman-proxy

</pre>

h3. Debian Linux 5.0 (Lenny)

Users of Debian Lenny will have to use "rake":http://packages.debian.org/lenny-backports/rake, "rack":http://packages.debian.org/lenny-backports/librack-ruby, and "Sinatra":http://packages.debian.org/lenny-backports/libsinatra-ruby from @lenny-backports@.

See http://backports.debian.org/Instructions/ for instructions on how to add @lenny-backports@ to your list of repositories and install a package from it.

Please note that you'll have to install the packages from @lenny-backports@ using @apt-get -t lenny-backports install libsinatra-ruby@.

h2. Configuration file

Usually can be found at /etc/foreman-proxy/settings.yml or on the config/settings.yml subdirectory.

You can use the @settings.yml.example@ file inside the @config@ directory as a template for your own [[settings.yml]].

If you don't plan to use one of the subsystems, please disable them in this configuration file.

h2. Start the daemon

<pre>

bin/smart-proxy.rb

</pre>

Or if you installed it via a package simply start the foreman-proxy service.

h2. Add the smart-proxy to the Foreman's Smart Proxy page

Go to [FOREMAN_URL]/smart_proxies and klick New Proxy

Then you type in the Name for your Proxy and the URL of your Proxy, with the Port you use.

For example: 

<pre>

Name: Puppet-Proxy

URL: http://puppet.your-domain.com:8443 

</pre>