Merge branch 'master' of gitorious.org:opensuse/build-service
[opensuse:build-service.git] / INSTALL
1 ===========================
2 Installation and Deployment
3 ===========================
4
5 This document explains how to setup the Open Build Service for development or
6 deployment.
7
8
9 Prerequisites
10 =============
11
12 Before you can start developing for the Open Build Service or deploying
13 it, you have to fetch some additional dependencies in the repository. Please
14 issue the following commands in your shell:
15
16  $ git submodule init
17  $ git submodule update
18  $ git pull origin master
19
20
21 Software dependencies
22 =====================
23
24 The various parts of the Open Build Service are implemented in different
25 languages. Therefore it has quite some additional dependencies. Also, it allows
26 to configure the database backend (e.g. you can even use SQLite3 for
27 development / testing and MySQL for production).
28
29 - Perl version 5.12.1 or later
30 - MySQL version 5.1.46 or later and / or SQLite3 version 3.6.23 or later
31 - Ruby version 1.8.7 and Ruby on Rails version 2.3.8 (exact versions)
32
33 To get all the dependencies and useful additional tools for openSUSE-11.3,
34 please issue the following commands as root user in your shell:
35
36  $ zypper addrepo --name "openSUSE-11.3 Tool" \
37     http://download.opensuse.org/repositories/openSUSE:/Tools/openSUSE_11.3/ \
38     opensuse-tools
39  $ zypper refresh
40  $ zypper install devel_rpm_build osc mysql-community-server sqlite3 \
41                   perl perl-Net-Domain perl-Net-SSLeay perl-BSSolv \
42                   perl-GD \
43                   ruby ruby-mysql rubygems rubygem-sqlite3 rubygem-rails-2_3 \
44                   rubygem-delayed_job rubygem-gruff rubygem-libxml-ruby \
45                   rubygem-sqlite3 rubygem-daemons rubygem-ci_reporter \
46                   rubygem-exception_notification rubygem-erubis rubygem-rails_xss \
47                   rubygem-ci_reporter
48
49 Deployment with RPM packages
50 ============================
51
52 Please have a look at the following file on how to set up a complete Build
53 Service instance from RPM packages: dist/README.SETUP
54
55
56 Deployment by hand
57 ==================
58
59 The Open Build Service is flexible enough to support several deployment scenarios.
60 These scenarios are described in the following (with increasing complexity).
61
62
63 Option 1: Only use the webui
64 ----------------------------
65
66 If you want to work only on the Rails web frontend (webui) or running your own
67 webui instance, there is no need to have an own backend server running. It is
68 sufficient to start the webui with its default values. For that to work you
69 have to change into its subdirectory and create the initial config like this:
70
71  $ cd src/webui
72  $ cp config/database.yml.example config/database.yml
73  $ rake db:setup
74
75 Afterwards you can simply start the webui like this:
76
77  $ ./script/server
78
79 Open up your favorite browser and enter the address http://127.0.0.1:3000/
80 and you should see your own Open Build Service webui instance. Thats it, actually.
81
82 To speed things up a bit, you can install a local memory cache like this (as
83 root in a terminal):
84
85  $ zypper in memcached
86  $ rcmemcached start
87  $ insserv memcached
88
89 You can also use Capistrano to deploy the web interface on production machines:
90
91  $ cap deploy:update        - Updates the sources on the server and changes the
92                               current symlink
93  $ cap deploy:migrate       - Runs database migrations
94  $ cap deploy               - Updates and restarts the server
95  $ cap deploy:pending       - or
96  $ cap deploy:pending:diff  - will show upcoming changes
97  $ cap deploy:rollback      - To get back to the previous version:
98
99 Additional information on how to set up your local development instance and how
100 to contribute can be found in the openSUSE wiki:
101
102     http://en.opensuse.org/openSUSE:Build_Service_Installation_Tutorial
103
104
105 Option 2: Setup a complete Open Build Service
106 ----------------------------------------
107
108 In addition to the steps described above, please refer to the file
109 src/backend/README. Afterwards, you have to configure your webui instance to
110 use your local api instance. Have a look at the documentation in the respective
111 files under src/webui/config/environments.