Welcome to pmbootstrap’s documentation!¶
pmbootstrap is the central command-line application for postmarketOS development. Among other things, it allows building packages, creating installation images and flashing themx to your device. If you just want to install postmarketOS, read the Installation wiki article first since you might not need pmbootstrap depeing on the method.
For the latest releases please check the repository.
In case of any problems that is also the place to check the issue-tracker.
For further information, please check out the postmarketOS-wiki.
Contents:
- Installation
- Usage
- pmbootstrap
- options
- pmbootstrap apkbuild_parse
- pmbootstrap apkindex_parse
- pmbootstrap aportgen
- pmbootstrap aportupgrade
- pmbootstrap bootimg_analyze
- pmbootstrap build
- pmbootstrap build_init
- pmbootstrap checksum
- pmbootstrap chroot
- pmbootstrap ci
- pmbootstrap config
- pmbootstrap deviceinfo_parse
- pmbootstrap export
- pmbootstrap flasher
- pmbootstrap flasher boot
- pmbootstrap flasher flash_dtbo
- pmbootstrap flasher flash_kernel
- pmbootstrap flasher flash_lk2nd
- pmbootstrap flasher flash_rootfs
- pmbootstrap flasher flash_vbmeta
- pmbootstrap flasher list_devices
- pmbootstrap flasher list_flavors
- pmbootstrap flasher sideload
- pmbootstrap index
- pmbootstrap init
- pmbootstrap initfs
- pmbootstrap initfs build
- pmbootstrap initfs extract
- pmbootstrap initfs hook_add
- pmbootstrap initfs hook_del
- pmbootstrap initfs hook_ls
- pmbootstrap initfs ls
- pmbootstrap install
- pmbootstrap kconfig
- pmbootstrap kconfig check
- pmbootstrap kconfig edit
- pmbootstrap kconfig migrate
- pmbootstrap lint
- pmbootstrap log
- pmbootstrap netboot
- pmbootstrap netboot serve
- pmbootstrap newapkbuild
- pmbootstrap pkgrel_bump
- pmbootstrap pkgver_bump
- pmbootstrap pull
- pmbootstrap qemu
- pmbootstrap repo_bootstrap
- pmbootstrap repo_missing
- pmbootstrap shutdown
- pmbootstrap sideload
- pmbootstrap stats
- pmbootstrap status
- pmbootstrap test
- pmbootstrap test apkindex_parse_all
- pmbootstrap update
- pmbootstrap work_migrate
- pmbootstrap zap
- Requirements
- pmbootstrap
- Chroot
- Debugging
- Cross Compiling
- SSH key handling
- pmbootstrap code documentation
- Mirror Configuration
- Environment Variables
Indices and tables¶
Deploying locally¶
To deploy with pmbootstrap ci command (see also: Pmbootstrap_CI wiki article):
cd /path/to/pmbootstrap
pmbootstrap ci docs
build succeeded.
The HTML pages are in public.
Copy CI artifacts to ./ci-artifacts/docs
After this, you should be able to host results with darkhttpd or Python’s built-in server:
python -m http.server -d ./ci-artifacts/docs/public
Note: This documentation is currently a work-in-progress, your feedback and contributions are very welcome!