{"id":13510786,"url":"https://github.com/osbuild/osbuild-getting-started","last_synced_at":"2025-10-11T17:45:33.262Z","repository":{"id":38095675,"uuid":"491417598","full_name":"osbuild/osbuild-getting-started","owner":"osbuild","description":"Makefile and Containerfiles to run the osbuild ecosystem locally.","archived":false,"fork":false,"pushed_at":"2025-09-04T09:58:20.000Z","size":92,"stargazers_count":6,"open_issues_count":8,"forks_count":9,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-10T23:17:53.422Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/osbuild.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-05-12T07:57:58.000Z","updated_at":"2025-09-04T09:58:24.000Z","dependencies_parsed_at":"2023-01-19T14:17:43.368Z","dependency_job_id":"de3b7724-343f-43e1-aa29-6c5c70aed245","html_url":"https://github.com/osbuild/osbuild-getting-started","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/osbuild/osbuild-getting-started","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osbuild%2Fosbuild-getting-started","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osbuild%2Fosbuild-getting-started/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osbuild%2Fosbuild-getting-started/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osbuild%2Fosbuild-getting-started/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/osbuild","download_url":"https://codeload.github.com/osbuild/osbuild-getting-started/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osbuild%2Fosbuild-getting-started/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279008134,"owners_count":26084397,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-11T02:00:06.511Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T02:01:53.955Z","updated_at":"2025-10-11T17:45:33.224Z","avatar_url":"https://github.com/osbuild.png","language":"Python","funding_links":[],"categories":["Python","others"],"sub_categories":[],"readme":"# Getting started with `osbuild`\n\nThe `osbuild` system is a group of applications, APIs, specifications, and\nimplementations to build images of Linux operating systems in an isolated\nand reliable way. Ready to be deployed to your favorite cloud provider,\nprivate hypervisor, or disk-media.\n\n## Ecosystem\n\nTasks are split out across a multitude of tools, here's a quick rundown\nof what each of them does.\n\n### osbuild\n\nAt the core of the project is the [osbuild](https://github.com/osbuild/osbuild)\nproject. This provides the build pipelines.\n\n### osbuild-composer\n\n[osbuild-composer](https://github.com/osbuild/osbuild-composer) is the higher\nlevel translation layer between front end tools and `osbuild`. It provides APIs\nthat can be used by web-frontends, cli-tools, and provides `osbuild` workers\nthat perform the build pipelines.\n\n### composer-cli\n\nThe [composer-cli](https://github.com/osbuild/weldr-client) (called\n`weldr-client` for historical reasons). Is one of the clients for\n`osbuild-composer`. It provides a command line interface to the exposed APIs.\n\n### image-builder\n\nThis is the console.redhat.com HTTP API that speaks to `osbuild-composer` and\ntranslates it for the `image-builder-frontend`.\n\n### image-builder-frontend\n\nThe frontend for console.redhat.com, it gets data from `image-builder`.\n\n## Products\n\nThe above section explains some of the individual components that are used by\nthe two products the `image-builder` team ships:\n  - an [on-premise](https://www.osbuild.org/guides/image-builder-on-premises/image-builder-on-premises.html) solution.\n  - our hosted [service](https://www.osbuild.org/guides/image-builder-service/architecture.html)\n\nThese products make use of the individual components in slightly different configurations. Our [guides](https://www.osbuild.org/guides)\nprovide more in-depth explainations of these products, their architecture and how they are configured.\n\n## Getting started\n\nFor further instructions on how to run containerized versions of the CLI and service locally:\n- the [on-premise README](./on-prem/README.md) offers explainations on how to run the on-premise CLI tool.\n- the [service README](./service/README.md) provides instructions on how to get started with a stack of the hosted service.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosbuild%2Fosbuild-getting-started","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fosbuild%2Fosbuild-getting-started","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosbuild%2Fosbuild-getting-started/lists"}