Go to file
Colin Walters 98d5f6e3db static-delta: Add `show` subcommand
Right now though, almost all of the details of deltas are private, so
we can't do the "honest thing" and have the command line just use the
shared library.

Eventually some of this should appear in the API, but for now add
command line which is useful for debugging.
2016-01-28 15:38:09 -05:00
apidoc apidoc: Remove unnecessary srcdir != builddir workaround 2016-01-28 09:31:37 -05:00
bsdiff@1edf9f6568 bsdiff: change submodule location 2015-03-26 23:33:07 +01:00
build-aux Add infrastructure for "make syntax-check" 2015-01-30 15:27:36 +01:00
docs Rewrite manual in mkdocs 2016-01-28 09:31:37 -05:00
docs-md README: Attempt to flesh out more, start moving docs from wiki 2015-07-28 18:39:43 -04:00
libglnx@769522753c repo: Port -refs.c to openat() 2016-01-28 14:57:13 -05:00
man build: Move man pages into man/ 2016-01-28 09:31:34 -05:00
manual-tests manual-tests: New directory with custom test scripts 2014-02-14 18:16:37 -05:00
packaging dist-packaging: Don't delete 91-ostree.preset, do clean old rpms/sources 2015-04-05 09:37:58 -04:00
src static-delta: Add `show` subcommand 2016-01-28 15:38:09 -05:00
tests repo: Port -refs.c to openat() 2016-01-28 14:57:13 -05:00
.gitignore Update .gitignore 2015-08-08 21:53:43 -04:00
.gitmodules bsdiff: change submodule location 2015-03-26 23:33:07 +01:00
CONTRIBUTING.md Rewrite manual in mkdocs 2016-01-28 09:31:37 -05:00
COPYING COPYING: Update to latest FSF with current address 2014-01-16 10:22:30 -05:00
GNUmakefile Add infrastructure for "make syntax-check" 2015-01-30 15:27:36 +01:00
Makefile-boot.am syntax-check: Remove empty lines at the end of file 2015-02-02 15:07:56 +01:00
Makefile-decls.am libostree: Add initial GRUB2 support 2014-10-16 14:15:00 -04:00
Makefile-libostree-defines.am build: ostree-gpg-verify-result.h is a public header, install it 2015-03-20 10:56:23 -04:00
Makefile-libostree.am build: Fix srcdir != builddir 2015-12-14 14:19:35 -05:00
Makefile-man.am build: Hoist man conditional higher 2016-01-28 15:34:38 -05:00
Makefile-ostree.am remote: Add "ostree remote summary" command 2015-12-17 15:49:51 -05:00
Makefile-otutil.am libotutil: Establish a place for GPG utilities 2015-05-01 10:20:34 -04:00
Makefile-switchroot.am Add support for mkinitcpio 2013-10-24 14:27:49 -04:00
Makefile-tests.am tests: add tests for prune and tombstones commits 2015-11-03 09:53:38 +01:00
Makefile.am build: Rename doc/ -> apidoc/ 2016-01-28 09:31:34 -05:00
README-historical.md README: Just link to wiki, move most of it to README-historical.md 2014-01-20 18:00:09 -05:00
README.md Rewrite manual in mkdocs 2016-01-28 09:31:37 -05:00
TODO Fix repeated words. 2015-01-30 15:27:36 +01:00
autogen.sh build: Make gtk-doc optional 2015-06-29 16:08:51 -04:00
cfg.mk build: exclude .sig files from syntax-check 2015-04-03 09:57:20 +02:00
configure.ac build: Add --disable-man 2016-01-28 15:22:10 -05:00
maint.mk tests: prefix invocation of ostree with where missing 2015-11-16 11:07:55 +01:00
mkdocs.yml Rewrite manual in mkdocs 2016-01-28 09:31:37 -05:00
ostree.doap doap category infrastructure 2014-07-31 11:26:32 +02:00

README.md

OSTree

OSTree is a tool that combines a "git-like" model for committing and downloading bootable filesystem trees, along with a layer for deploying them and managing the bootloader configuration.

Traditional package managers (dpkg/rpm) build filesystem trees on the client side. In contrast, the primary focus of OSTree is on replicating trees composed on a server.

Features:

  • Atomic upgrades and rollback
  • GPG signatures and "pinned TLS" support
  • Support for parallel installing more than just 2 bootable roots
  • Binary history on the server side
  • Introspectable shared library API for build and deployment systems

Projects using OSTree

rpm-ostree is a tool that uses OSTree as a shared library, and supports committing RPMs into an OSTree repository, and deploying them on the client.

Project Atomic uses rpm-ostree to provide a minimal host for Docker formatted Linux containers.

xdg-app uses OSTree for desktop application containers.

GNOME Continuous is a custom build system designed for OSTree, using OpenEmbedded in concert with a custom build system to do continuous delivery from hundreds of git repositories.

Building

Releases are available as GPG signed git tags, and most recent versions support extended validation using git-evtag.

However, in order to build from a git clone, you must update the submodules. If you're packaging OSTree and want a tarball, I recommend using a "recursive git archive" script. There are several available online; this code in OSTree is an example.

Once you have a git clone or recursive archive, building is the same as almost every autotools project:

env NOCONFIGURE=1 ./autogen.sh
./configure --prefix=...
make
make install DESTDIR=/path/to/dest

More documentation

Some more information is available on the old wiki page: https://wiki.gnome.org/Projects/OSTree

The intent is for that wiki page content to be migrated into Markdown in this git repository.

Contributing

See Contributing.