Expanded the webui-only deployment scenario.
[opensuse:build-service.git] / INSTALL
1 ============================
2 Installation and development
3 ============================
4
5 This document explains how to setup the Build Service for development or
6 deployment.
7
8
9 Prerequisites
10 =============
11
12 Before you can start developing for the openSUSE 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 openSUSE Build Service are implemented in different
25 languages. Also, it allows to configure the database backend (e.g. you can even
26 use SQLite3 for development/testint and MySQL for production).
27
28 - Perl version 5.12.1 or later
29 - MySQL version 5.1.46 or later and / or
30 - SQLite3 version 3.6.23 or later
31 - Ruby version 1.8.7 and Ruby on Rails version 2.3.5 or 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                   ruby ruby-mysql rubygems rubygem-sqlite3 rubygem-rails-2_3 \
43                   rubygem-delayed_job rubygem-gruff rubygem-libxml-ruby \
44                   rubygem-sqlite3 rubygem-daemons \
45                   rubygem-exception_notification
46
47
48 Deployment
49 ==========
50
51 The Build Service is flexible enough to support several deployment scenarios.
52 These scenarios are described in the following (with increasing complexity).
53
54
55 Option 1: Only use the webui
56 ----------------------------
57
58 If you want to work only on the Rails web frontend (webui) or running your own
59 webui instance, there is no need to have an own backend server running. It is
60 sufficient to start the webui with its default values. For that to work you
61 have to change into its subdirectory and create the initial config like this:
62
63  $ cd src/webui
64  $ cp config/database.yml.example config/database.yml
65
66 Afterwards you can simply start the webui like this:
67
68  $ ./scripts/server
69
70 Open up your favorite browser and enter the address http://127.0.0.1:3000/
71 and you should see your own Build Service webui instance.
72
73
74 Option 2: Use the webui and api
75 -------------------------------
76
77 TODO
78
79
80 Option 2: Setup a complete Build Service
81 ----------------------------------------
82
83 TODO
84
85
86 Development
87 ===========
88
89 TODO