https://github.com/ggiamarchi/rpi-debian-builder
Build your own Debian image for Raspberry Pi
https://github.com/ggiamarchi/rpi-debian-builder
debian distribution linux raspberry-pi raspberrypi
Last synced: about 1 year ago
JSON representation
Build your own Debian image for Raspberry Pi
- Host: GitHub
- URL: https://github.com/ggiamarchi/rpi-debian-builder
- Owner: ggiamarchi
- License: mit
- Created: 2016-01-13T00:33:28.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2019-09-24T12:32:44.000Z (over 6 years ago)
- Last Synced: 2025-05-09T02:13:48.488Z (about 1 year ago)
- Topics: debian, distribution, linux, raspberry-pi, raspberrypi
- Language: Shell
- Size: 24.4 KB
- Stars: 10
- Watchers: 1
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RPi Debian Builder
[](https://travis-ci.org/ggiamarchi/rpi-debian-builder)
Build your custom Debian image for RaspberryPi easily.
## Requirements
This tool runs under linux and needs some system requirements. Because it needs to be run
as root (for the chroot purspose) it is highly recommended to run it inside a virtual machine.
## Quickstart
The easiest way to run it is to use [Vagrant](https://www.vagrantup.com/) to create a fresh VM,
install requirements and then run the image build.
from the project directory
```
vagrant up
vagrant ssh
sudo su
cd /vagrant
```
Now you are inside the VM as root in the project directory, ready to run the image build. To do
so, you can do it without any customization running the command
```
./rpi-debian-builder --config config.json --modules basic
```
It uses the `basic` module which perform some elementary configuration. It is recommended to
always use it unless you really know what you are doing.
## Modules
A module is a directory containing
* static files to deploy to the target filesystem
* templates to generate files to the target filesystem
* provisioning scripts
### Module directory structure
```
modules
|-- module1
| |-- initialize
| | |-- files
| | |-- templates
| | |-- scripts
| |
| |-- provision
| | |-- files
| | |-- templates
| | |-- scripts
| |
| |-- finish
| |-- files
| |-- templates
| |-- scripts
|
|-- module2
| |-- ...
```
Module phases:
* `initialize` - This phase runs before any other provisioning. It runs outside the chroot context
* `provision` - This phase runs after built-in provisioning. It runs in a chroot context
* `finish` - This phase runs after the `provision` one. It runs in a chroot context
In any phase, files and templates are always relative to the root of the filesystem of the target
operating system.
### Use your own modules
To use your own module, just copy it in the `modules` directory and make reference to it on the command
line when you run the `rpi-debian-builder` command. You can reference as many module as you want (comma
separated).
## License
Everything in this repository is published under the MIT license.