rpm-ostree/README.md

# rpm-ostree: A true hybrid image/package system

rpm-ostree is a hybrid image/package system.  It combines
[libostree](https://ostree.readthedocs.io/en/latest/) as a base image format,
and accepts RPM on both the client and server side, sharing code with the
[dnf](https://en.wikipedia.org/wiki/DNF_(software)) project; specifically
[libdnf](https://github.com/rpm-software-management/libdnf). and thus bringing
many of the benefits of both together.

```
                         +-----------------------------------------+
                         |                                         |
                         |       rpm-ostree (daemon + CLI)         |
                  +------>                                         <---------+
                  |      |     status, upgrade, rollback,          |         |
                  |      |     pkg layering, initramfs --enable    |         |
                  |      |                                         |         |
                  |      +-----------------------------------------+         |
                  |                                                          |
                  |                                                          |
                  |                                                          |
+-----------------|-------------------------+        +-----------------------|-----------------+
|                                           |        |                                         |
|         libostree (image system)          |        |            libdnf (pkg system)          |
|                                           |        |                                         |
|   C API, hardlink fs trees, system repo,  |        |    ties together libsolv (SAT solver)   |
|   commits, atomic bootloader swap         |        |    with librepo (RPM repo downloads)    |
|                                           |        |                                         |
+-------------------------------------------+        +-----------------------------------------+
```

**Features:**

 - Transactional, background image-based (versioned/checksummed) upgrades
 - OS rollback without affecting user data (`/usr` but not `/etc`, `/var`) via libostree
 - Client-side package layering (and overrides)
 - Easily make your own: `rpm-ostree compose tree` and [CoreOS Assembler](https://github.com/coreos/coreos-assembler)

## Documentation

For more information, see the [project documentation](docs/index.md) or the
[project documentation website](https://coreos.github.io/rpm-ostree).

## License

rpm-ostree includes code licensed under GPLv2+, LGPLv2+, (Apache 2.0 OR MIT).
For more information, see [LICENSE](https://github.com/coreos/rpm-ostree/blob/master/LICENSE).
README.md: Add arch diagram, tweak wording, add talk links There's a lot more we could do here but I think the architecture diagram in particular helps a lot. Closes: #1245 Approved by: jlebon 2018-02-14 00:15:10 +03:00			`# rpm-ostree: A true hybrid image/package system`

docs: Unify and update README and Index page 2020-09-30 19:22:55 +03:00			`rpm-ostree is a hybrid image/package system. It combines`
			`[libostree](https://ostree.readthedocs.io/en/latest/) as a base image format,`
			`and accepts RPM on both the client and server side, sharing code with the`
			`[dnf](https://en.wikipedia.org/wiki/DNF_(software)) project; specifically`
			`[libdnf](https://github.com/rpm-software-management/libdnf). and thus bringing`
README.md: Add arch diagram, tweak wording, add talk links There's a lot more we could do here but I think the architecture diagram in particular helps a lot. Closes: #1245 Approved by: jlebon 2018-02-14 00:15:10 +03:00			`many of the benefits of both together.`

			```
			`+-----------------------------------------+`
			`\| \|`
			`\| rpm-ostree (daemon + CLI) \|`
			`+------> <---------+`
			`\| \| status, upgrade, rollback, \| \|`
			`\| \| pkg layering, initramfs --enable \| \|`
			`\| \| \| \|`
			`\| +-----------------------------------------+ \|`
			`\| \|`
			`\| \|`
			`\| \|`
			`+-----------------\|-------------------------+ +-----------------------\|-----------------+`
			`\| \| \| \|`
			`\| libostree (image system) \| \| libdnf (pkg system) \|`
			`\| \| \| \|`
			`\| C API, hardlink fs trees, system repo, \| \| ties together libsolv (SAT solver) \|`
			`\| commits, atomic bootloader swap \| \| with librepo (RPM repo downloads) \|`
			`\| \| \| \|`
			`+-------------------------------------------+ +-----------------------------------------+`
			```
README.md: Add more docs 2014-10-31 21:39:57 +03:00
docs: Start using mkdocs Matching https://git.gnome.org/browse/ostree/commit/docs/CONTRIBUTING.md?id=64ebe2b82ac25f1933f39a5cf8a24a5e0096cf6f 2016-03-09 18:58:13 +03:00			`Features:`

README.md: Add arch diagram, tweak wording, add talk links There's a lot more we could do here but I think the architecture diagram in particular helps a lot. Closes: #1245 Approved by: jlebon 2018-02-14 00:15:10 +03:00			`- Transactional, background image-based (versioned/checksummed) upgrades`
			- OS rollback without affecting user data (`/usr` but not `/etc`, `/var`) via libostree
			`- Client-side package layering (and overrides)`
README.md: Add a "why" section, update background.md Point at FCOS and not Project Atomic. Add an inline "Why" section since people will want to know that right away. (An great thing about Github is the prevalence it gives to `README.md`; projects should use that as an "elevator pitch") Drop outdated bits in `background.md`. Closes: #1895 Approved by: jlebon 2019-09-04 15:29:17 +03:00			- Easily make your own: `rpm-ostree compose tree` and [CoreOS Assembler](https://github.com/coreos/coreos-assembler)
docs: Start using mkdocs Matching https://git.gnome.org/browse/ostree/commit/docs/CONTRIBUTING.md?id=64ebe2b82ac25f1933f39a5cf8a24a5e0096cf6f 2016-03-09 18:58:13 +03:00
docs: Unify and update README and Index page 2020-09-30 19:22:55 +03:00			`## Documentation`

			`For more information, see the [project documentation](docs/index.md) or the`
			`[project documentation website](https://coreos.github.io/rpm-ostree).`

			`## License`
Clarify license situation to include GPLv2, relicense Rust code We have contacted all contributors to the code in `rust/` and that code is now all relicensed under the "standard Rust license" of `Apache 2.0 OR MIT`. [Due to an accident](https://github.com/projectatomic/rpm-ostree/issues/1890), some GPLv2+ code was imported in the C side, and we're unlikely to easily change that now. Make this more official by adding the GPLv2. I'd like to go through the C code and add SPDX and possibly investigate relicensing some of the GPLv2+ code to LGPLv2+ but, not right now. For a bit more about Rust and SPDX, see [this issue](https://github.com/rust-lang/cargo/issues/2039). Closes: https://github.com/projectatomic/rpm-ostree/issues/1890 Closes: #1897 Approved by: jlebon 2019-09-05 17:52:38 +03:00
			`rpm-ostree includes code licensed under GPLv2+, LGPLv2+, (Apache 2.0 OR MIT).`
README.md: Keep it short and sweet Let's keep the bulk of the documentation in the README in the docs site landing page instead. That way, changing text there doesn't require changing it in two places. 2020-10-01 19:02:52 +03:00			`For more information, see [LICENSE](https://github.com/coreos/rpm-ostree/blob/master/LICENSE).`