Project

General

Profile

Installation instructions » History » Version 16

Ohad Levy, 12/14/2009 07:12 AM

1 8 Ohad Levy
{{toc}}
2 1 Ohad Levy
3 8 Ohad Levy
h1. Requirements
4 8 Ohad Levy
5 1 Ohad Levy
before you start, make sure you have:
6 1 Ohad Levy
7 1 Ohad Levy
* Puppet >= 0.24-4
8 1 Ohad Levy
* rake >= 0.84 
9 8 Ohad Levy
* rubygems
10 8 Ohad Levy
* ruby-sqlite3 (libsqlite3-ruby) if you are going to use sqlite as your database
11 8 Ohad Levy
* git (if installing from source )
12 1 Ohad Levy
13 1 Ohad Levy
The installation has been successfully tested on RHE5 and Ubuntu 8.04 -  9.04,  for older operating systems you might need additional packages (e.g. sqlite)
14 1 Ohad Levy
15 8 Ohad Levy
h1. Download
16 1 Ohad Levy
17 13 Ohad Levy
h2. Puppet Module ready to use
18 13 Ohad Levy
19 13 Ohad Levy
You may try out the puppet Foreman module, this should take care for most of the basic setup.
20 13 Ohad Levy
21 13 Ohad Levy
The module could be found here: source:extras/puppet/foreman
22 13 Ohad Levy
23 13 Ohad Levy
*Its recommend to review the module prior usage.*
24 13 Ohad Levy
25 8 Ohad Levy
h2. Latest stable release
26 7 Ohad Levy
27 16 Ohad Levy
Latest stable version can be found "here":http://theforeman.org/attachments/download/53/foreman-0.1-3.tar.bz2
28 8 Ohad Levy
h2. Latest source code
29 7 Ohad Levy
30 7 Ohad Levy
You can get the latest source code of Foreman from the git repository hosted at github.
31 7 Ohad Levy
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.
32 7 Ohad Levy
33 1 Ohad Levy
to get latest "stable" version do:
34 1 Ohad Levy
35 4 Ohad Levy
<pre><code>git clone git://github.com/ohadlevy/foreman.git foreman
36 4 Ohad Levy
cd foreman
37 1 Ohad Levy
git submodule init
38 1 Ohad Levy
git submodule update
39 1 Ohad Levy
</code></pre>
40 1 Ohad Levy
41 1 Ohad Levy
* if you are behind a proxy or firewall and dont have access to github using the git protocol, use http protocol instead (e.g.)
42 5 Rama Krishna
<pre>
43 5 Rama Krishna
git clone http://github.com/ohadlevy/foreman.git foreman
44 5 Rama Krishna
cd foreman
45 1 Ohad Levy
sed -i 's/git:\/\//http:\/\//g' .gitmodules
46 1 Ohad Levy
git submodule init
47 5 Rama Krishna
git submodule update
48 5 Rama Krishna
</pre>
49 5 Rama Krishna
50 12 Ohad Levy
h3. Daily snapshot
51 12 Ohad Levy
52 12 Ohad Levy
You can also fetch the latest daily snapshot of the development version at:
53 12 Ohad Levy
http://thetorque.org/foreman-nightly.tar.bz2
54 12 Ohad Levy
55 3 Ohad Levy
56 8 Ohad Levy
h1. Initial setup
57 1 Ohad Levy
58 8 Ohad Levy
h2. Database
59 6 Ohad Levy
60 6 Ohad Levy
Foreman uses a database, this database can be shared with Puppet store-configs (they are compatible, as Foreman extends the puppet database schema).
61 14 Ohad Levy
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+.
62 1 Ohad Levy
63 6 Ohad Levy
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.
64 6 Ohad Levy
65 1 Ohad Levy
In both cases, please use the *production* settings.
66 6 Ohad Levy
67 1 Ohad Levy
to initialize the database schema type:
68 11 Ohad Levy
<pre>
69 11 Ohad Levy
RAILS_ENV=production rake db:migrate
70 11 Ohad Levy
</pre>
71 6 Ohad Levy
72 8 Ohad Levy
h2. Import Data from Puppet
73 6 Ohad Levy
74 6 Ohad Levy
At this point, you might want to go through the [[FAQ]] to see how can you import your data into Foreman.
75 6 Ohad Levy
76 8 Ohad Levy
h2. Start The Web Server
77 6 Ohad Levy
78 6 Ohad Levy
Start the built in web server by typing:
79 1 Ohad Levy
<code>./script/server -e production</code>
80 1 Ohad Levy
81 6 Ohad Levy
and point your browser to http://foreman:3000
82 1 Ohad Levy
83 14 Ohad Levy
If you would like to keep the server running, I would recommend to setup passenger, an puppet manifest example could be found source:extras/puppet/foreman/templates/foreman-vhost.conf.erb
84 1 Ohad Levy
85 8 Ohad Levy
h1. Future Updates
86 1 Ohad Levy
87 9 Ohad Levy
see [[Upgrade instructions]]
88 1 Ohad Levy
89 9 Ohad Levy
h1. Problems?
90 9 Ohad Levy
91 9 Ohad Levy
see [[Troubleshooting]]