ostree/docs
Alexander Larsson 81fa214155 Read composefs configuration from initrd instead of commandline
This drops the `ot-composefs` kernel commandline in favour
of a `[composefs]` section in the `prepare-rootfs.conf` file.

You can set `composefs.enabled` to `signed`, `yes`, `no` or `maybe`,
with `maybe` being the default.

You can also set `composefs.keypath` (or rely on the default
`/etc/ostree/initramfs-root-binding.key`) to point to ed25519 public
keys, one of which which the commit must be signed with, or boot
fails.

The ostree dracut module adds `/etc/ostree/initramfs-root-binding.key`
to the initrd if it exists.

NOTE: This drop the option to define a digest in the commandline.
However, that was currently unused
(i.e. ComposefsConfig.expected_digest was never read).

Additionally it very hard to actually store the composefs digest in
the initrd, as the initrd is typically part of the commit and thus the
composefs. It may be possible to handle this, but lets add it back
when we know exactly how that will work.
2023-08-14 12:27:47 +02:00
..
_sass/color_schemes docs: Add Jekyll and theme config 2020-10-01 19:32:12 +02:00
_config.yml docs: Use upstream theme & update to 0.4.1 2023-03-10 12:17:16 +01:00
adapting-existing.md docs: Update user and group section 2023-06-29 11:05:31 -04:00
atomic-upgrades.md *: rename master to main in tests & examples 2021-05-07 16:55:03 +02:00
buildsystem-and-repos.md docs: Fix various typos 2020-10-19 10:55:49 -04:00
composefs.md Read composefs configuration from initrd instead of commandline 2023-08-14 12:27:47 +02:00
contributing-tutorial.md Update doc about adding new function to libostree 2022-07-14 16:05:53 +08:00
CONTRIBUTING.md *: rename master branch to main 2021-05-07 16:55:03 +02:00
deployment.md docs: update boot loader spec link 2023-07-25 21:42:41 +02:00
formats.md lib/core: introduce 'bare-split-xattrs' mode 2022-03-02 16:45:00 +00:00
Gemfile docs: Provide bundler setup for building site locally 2021-05-21 10:13:15 -06:00
ima.md docs/ima: Also link the SUSE docs 2022-05-06 14:43:58 -04:00
index.md docs: Fix link to ostree-rs 2023-02-05 11:49:41 +06:00
introduction.md docs: Move and update pages from the manual 2020-10-02 14:34:48 +02:00
prep-docs.sh docs: Publish man pages 2022-04-08 19:25:32 -06:00
README-historical.md docs: Move historical README to the docs 2020-10-02 14:38:28 +02:00
README.md docs: Copy in API docs and add link 2021-05-21 10:46:49 -06:00
related-projects.md docs: Add Torizon to related projects and OS 2021-03-04 17:04:38 -03:00
repo.md lib/core: introduce 'bare-split-xattrs' mode 2022-03-02 16:45:00 +00:00
repository-management.md *: rename master to main in tests & examples 2021-05-07 16:55:03 +02:00

This documentation is written in Jekyll format to be published on GitHub Pages. The rendered HTML will be automatically built and published, but you can also use Jekyll locally to test changes.

First you need to install Ruby and RubyGems to get Jekyll and the other gem dependencies. This is easiest using the distro's packages. On RedHat systems this is rubygems and on Debian systems this is ruby-rubygems.

Next Bundler is needed to install the gems using the provided Gemfile. You can do this by running gem install bundler or using distro packages. On RedHat systems this is rubygem-bundler and on Debian systems this is ruby-bundler.

Now you can prepare the Jekyll environment. Change to this directory and run:

bundle config set --local path vendor/bundle
bundle install

Finally, run the prep-docs.sh script and then render and serve the site locally with Jekyll:

./prep-docs.sh
bundle exec jekyll serve