1OSTREE(1) ostree OSTREE(1)
2
6 ostree - Manage multiple bootable versioned filesystem trees
7
9 ostree {COMMAND} [OPTIONS...]
10
12 OSTree is a tool for managing multiple bootable versioned filesystem
13 trees, or just "tree" for short. In the OSTree model, operating systems
14 no longer live in the physical "/" root directory. Instead, they
15 parallel install to the new toplevel /ostree directory. Each installed
16 system gets its own /ostree/deploy/stateroot directory. (stateroot is
17 the newer term for osname).
18 Unlike rpm or dpkg, OSTree is only aware of complete filesystem trees.
20 It has no built-in knowledge of what components went into creating the
21 filesystem tree.
22 It is possible to use OSTree in several modes; the most basic form is
24 to replicate pre-built trees from a build server. Usually, these
25 pre-built trees are derived from packages. You might also be using
26 OSTree underneath a higher level tool which computes filesystem trees
27 locally.
28 It must be emphasized that OSTree only supports read-only trees. To
30 change to a different tree (upgrade, downgrade, install software), a
31 new tree is checked out, and a 3-way merge of configuration is
32 performed. The currently running tree is not ever modified; the new
33 tree will become active on a system reboot.
34 To see the man page for a command run man ostree COMMAND or man
36 ostree-admin COMMAND
37
39 The following options are understood:
40 --repo
42 For most commands, a repository is required. If unspecified, the
43 current directory is used if it appears to be an OSTree repository.
44 If it isn't, either the OSTREE_REPO environment variable is used,
45 or the system repository located at /sysroot/ostree/repo.
46 -v, --verbose
48 Produce debug level output.
49
51 System administrators will primarily interact with OSTree via the
52 subcommand ostree admin.
53 ostree-admin-cleanup(1)
55 Delete untagged deployments and repository objects.
56 ostree-admin-config-diff(1)
58 See changes to /etc as compared to the current default (from
59 /usr/etc).
60 ostree-admin-deploy(1)
62 Takes a particular commit or revision, and sets it up for the next
63 boot.
64 ostree-admin-init-fs(1)
66 Initialize a root filesystem in a specified path.
67 ostree-admin-instutil(1)
69 Utility functions intended primarily for operating system
70 installation programs
71 ostree-admin-os-init(1)
73 Initialize the deployment location for an operating system with a
74 specified name.
75 ostree-admin-status(1)
77 Show and list the deployments.
78 ostree-admin-switch(1)
80 Choose a different ref to track from the same remote as the
81 current tree.
82 ostree-admin-undeploy(1)
84 Remove the previously INDEX deployed tree from the bootloader
85 configuration.
86 ostree-admin-upgrade(1)
88 Download the latest version for the current ref, and deploy it.
89 Both administrators and operating system builders may interact with
91 OSTree via the regular filesystem manipulation commands.
92 ostree-cat(1)
94 Concatenate contents of files
95 ostree-checkout(1)
97 Check out a commit into a filesystem tree.
98 ostree-checksum(1)
100 Gives checksum of any file.
101 ostree-commit(1)
103 Given one or more trees, create a new commit using those contents.
104 ostree-config(1)
106 Change settings.
107 ostree-create-usb(1)
109 Put the given refs on an external drive for P2P distribution.
110 ostree-diff(1)
112 Concisely list differences between the given refs.
113 ostree-find-remotes(1)
115 Find remotes to serve the given refs.
116 ostree-fsck(1)
118 Check a repository for consistency.
119 ostree-init(1)
121 Initialize a new repository.
122 ostree-log(1)
124 Show revision log.
125 ostree-ls(1)
127 List the contents of a given commit.
128 ostree-prune(1)
130 Search for unreachable objects.
131 ostree-pull-local(1)
133 Copy data from source-repo.
134 ostree-pull(1)
136 Download data from remote repo. If you have libsoup.
137 ostree-refs(1)
139 List refs.
140 ostree-remote(1)
142 Manipulate remote archive configuration.
143 ostree-reset(1)
145 Reset a ref to a previous commit.
146 ostree-rev-parse(1)
148 Show the SHA256 corresponding to a given rev.
149 ostree-show(1)
151 Given an OSTree SHA256 checksum, display its contents.
152 ostree-static-delta(1)
154 Manage static delta files.
155 ostree-summary(1)
157 Regenerate the repository summary metadata.
158 ostree-trivial-httpd(1)
160 Simple webserver.
161
163 For specific examples, please see the man page regarding the specific
164 ostree command. For example:
165 man ostree init or man ostree-admin status
167
169 OSTree supports signing commits with GPG. Operations on the system
170 repository by default use keyring files in
171 /usr/share/ostree/trusted.gpg.d. Any public key in a keyring file in
172 that directory will be trusted by the client. No private keys should be
173 present in this directory.
174 In addition to the system repository, OSTree supports two other paths.
176 First, there is a gpgkeypath option for remotes, which must point to
177 the filename of an ASCII-armored GPG key, or a directory containing
178 ASCII-armored GPG keys to import. Multiple file and directory paths to
179 import from can be specified, as a comma-separated list of paths. This
180 option may be specified by using --set in ostree remote add.
181 Second, there is support for a per-remote remotename.trustedkeys.gpg
183 file stored in the toplevel of the repository (alongside objects/ and
184 such). This is particularly useful when downloading content that may
185 not be fully trusted (e.g. you want to inspect it but not deploy it as
186 an OS), or use it for containers. This file is written via ostree
187 remote add --gpg-import.
188
190 ostree.repo(5)
191OSTree OSTREE(1)