Skip to content

Latest commit

 

History

History
58 lines (40 loc) · 4.31 KB

README.md

File metadata and controls

58 lines (40 loc) · 4.31 KB
Raw

Build Status Code Coverage Code Climate Depfu CII Best Practices build result

Open Build Service

The Open Build Service (OBS) is a generic system to build and distribute binary packages from sources in an automatic, consistent, and reproducible way. You can release packages as well as updates, add-ons, appliances, and entire distributions for a wide range of operating systems and hardware architectures. More information can be found on openbuildservice.org.

The OBS consists of a backend and a frontend. The backend implements all the core functionality (i.e. building packages). The frontend provides a web application and XML API for interacting with the backend. Additionally, there is a command line client (osc) for the API which is developed in a separate repository.

Licensing

The Open Build Service is Free Software and is released under the terms of the GPL, except where noted. Additionally, 3rd-party content (like, but not exclusively, the webui icon theme) may be released under a different license. Please check the respective files for details.

Community

You can discuss with the OBS Team via IRC on the channel #opensuse-buildservice or you can use our mailing list opensuse-buildservice@opensuse.org. Please refer to the openSUSE Mailing Lists page to learn about our mailing list subscription and additional information.

Development / Contribution

If you want to contribute to the OBS, please checkout our contribution readme:-)

Source Code Repository Layout

The OBS source code repository is hosted on Github and organized like this:

    dist          Files relevant for our distribution packages
    docs          Documentation, examples and schema files
    src/api       Rails app (Ruby on Rails)
    src/backend   Backend code (Perl)

Installation

To run the OBS in production, we recommend using our appliance which is the whole package: A recent and stable Linux Operating System (openSUSE) bundled and pre-configured with all the server and OBS components you need to get going.

If that is not for you because you have some special needs for your setup (e.g. different partition schema, SLES as base system, etc.), you can also install our packages and run a setup wizard. The docker-compose setup is meant only for development.

After finishing the installation of your base system, follow these steps:

  1. Add the OBS software repository with zypper. Please be aware, that the needed URL differs, depending on your Base Operating System. We use openSUSE Leap 15.1 in this example.

    zypper ar -f https://download.opensuse.org/repositories/OBS:/Server:/2.10/openSUSE_15.1/OBS:Server:2.10.repo

  2. Install the package

    zypper in -t pattern OBS_Server

  3. Run our setup wizard

    /usr/lib/obs/server/setup-appliance.sh --force

Advanced Setup

If you have a more complex setup (e.g. a distributed backend), we recommend to read the Administration chapter in our user manual.