{{toc}}

h1. Requirements

before you start, make sure you have:

* Puppet >= 0.24-4

* rake >= 0.84 

* rubygems

* rack = 1.0.1

* ruby-sqlite3 (libsqlite3-ruby) if you are going to use sqlite as your database

* git (if installing from source )

The installation has been successfully tested on RHE5 and Ubuntu 8.04 -  9.10,  for older operating systems you might need additional packages (e.g. sqlite)

h1. Download

h2. Puppet Module ready to use

You may try out the puppet Foreman module, this should take care for most of the basic setup.

The module could be found here: source:extras/puppet/foreman

The module is inlcuded in the official tarbar in the extras/puppet sub directory, you may extract it from this archive: http://thetorque.org/foreman-nightly.tar.bz2

you may use puppet (if you dont want to add it as a module to your puppetmaster) in the following way:

<pre>

echo include foreman | puppet  --verbose --modulepath /path_to/tarball/extras/puppet

</pre>

if you would like to setup passenger as well, you can 

<pre>

echo include foreman::passenger | puppet  --verbose --modulepath /path_to/tarball/extras/puppet

</pre>

*Its recommend to review the module prior usage.*

h2. Latest stable release

Latest stable version can be found "here":http://theforeman.org/attachments/download/60/foreman-0.1-4.tar.bz2

h2. Latest source code

You can get the latest source code of Foreman from the git repository hosted at github.

This is the preferred way to get Foreman if you want to benefit from the latest improvements. By using the git repository you can also upgrade more easily.

to get latest "stable" version do:

<pre><code>git clone git://github.com/ohadlevy/foreman.git foreman

cd foreman

git submodule init

git submodule update

</code></pre>

* if you are behind a proxy or firewall and dont have access to github using the git protocol, use http protocol instead (e.g.)

<pre>

git clone http://github.com/ohadlevy/foreman.git foreman

cd foreman

sed -i 's/git:\/\//http:\/\//g' .gitmodules

git submodule init

git submodule update

</pre>

h3. Daily snapshot

You can also fetch the latest daily snapshot of the development version at:

http://thetorque.org/foreman-nightly.tar.bz2

h1. Initial setup

h2. Database

Foreman uses a database, this database can be shared with Puppet store-configs (they are compatible, as Foreman extends the puppet database schema).

By default, SQLite is used, if you want to use other database (e.g. [[FAQ#I-want-to-use-MySQL|MySQL]]) please modify the configuration file under +config/database.yml+.

If you want to share the database with Puppets (storeconfig), just modify +config/database.yml+ to point to the same database configuration as puppet is.

In both cases, please use the *production* settings.

to initialize the database schema type:

<pre>

RAILS_ENV=production rake db:migrate

</pre>

h2. Import Data from Puppet

At this point, you might want to go through the [[FAQ]] to see how can you import your data into Foreman.

h2. Start The Web Server

Start the built in web server by typing:

<code>./script/server -e production</code>

and point your browser to http://foreman:3000

If you would like to keep the server running, its recommend to setup passenger, an example puppet manifest could be found source:extras/puppet/foreman/templates/foreman-vhost.conf.erb

h1. Future Updates

see [[Upgrade instructions]]

h1. Problems?

see [[Troubleshooting]]