os-build-system/README.md

118 lines
3.2 KiB
Markdown

# DECODE OS - build system
DECODE's operating system is designed to run a DECODE NODE that
automatically connects to DECODE's P2P network and executes smart
rules according to authenticated entitlements on attributes.
For stable releases see https://files.dyne.org/decode
## Requirements
A GNU/Linux system is required in order to build DECODE OS.
Here a list of package dependencies:
```
zsh sudo cgpt xz-utils qemu qemu-utils
```
In addition one must install `vagrant` and `virtualbox` from latest
published packages (do not use distro provided packages, as they are
updated).
To update this repository, simply issue:
```
$ git pull origin master && git submodule update --init --recursive --checkout
```
## Getting started
To enter the build console just run `./console.sh`.
To build a vagrant virtual machine, run `build_vagrant_dist`.
To build a live iso image, run `build_iso_dist`.
To build an ARM installer image, run `build_image_dist`.
Here below the sequences of build steps executed by each target:
```zsh
build_image_dist() {
bootstrap_complete_base
blend_preinst
image_prepare_raw
image_partition_raw_${parted_type}
build_kernel_${arch}
blend_postinst
rsync_to_raw_image
image_pack_dist
}
build_iso_dist() {
bootstrap_complete_base
blend_preinst
iso_prepare_strap
build_kernel_${arch}
iso_setup_isolinux
iso_write_isolinux_cfg
blend_postinst
fill_apt_cache
iso_squash_strap
iso_xorriso_build
}
build_vagrant_dist() {
image_${imageformat}_as_strapdir
bootstrap_complete_base
vm_inject_overrides
blend_preinst
vm_setup_grub
blend_postinst
vm_umount_${imageformat}
vm_vbox_setup
vm_vagrant_package
vm_pack_dist
}
```
The `build_vagrant_dist` target is a helper that executes a sequence
of steps, some of them common to other helpers (hence
combinable). Here below the full list of build steps executed by
`build_vagrant_dist`
The `bootstrap_complete_base` step creates a base system tarball that
can be reused by any target, it is found inside `*_sdk/tmp` for each
sdk and to save time and computation it can be copied in place for
each sdk if the base system doesn't differ.
## Acknowledgments
The Devuan SDK used to build the DECODE OS was originally conceived
during a period of residency at the Schumacher college in Dartington,
UK. Greatly inspired by the laborious and mindful atmosphere of its
wonderful premises.
The Devuan SDK is Copyright (c) 2015-2017 by the Dyne.org Foundation
Devuan SDK components were designed, and are written and maintained by:
- Ivan J. <parazyd@dyne.org>
- Denis Roio <jaromil@dyne.org>
- Enzo Nicosia <katolaz@freaknet.org>
This source code is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option)
any later version.
This software is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
more details.
You should have received a copy of the GNU General Public License along
with this source code. If not, see <http://www.gnu.org/licenses/>.