Compare commits
3 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| f8b9af4d61 | |||
| 0bb0c31e48 | |||
| 9466b2e477 |
160
LICENSE
160
LICENSE
@ -1,13 +1,159 @@
|
|||||||
Copyright (c) 2015 Raspberry Pi (Trading) Ltd.
|
Creative Commons Attribution-NonCommercial 4.0 International
|
||||||
|
|
||||||
All rights reserved.
|
Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible.
|
||||||
|
|
||||||
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
Using Creative Commons Public Licenses
|
||||||
|
|
||||||
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses.
|
||||||
|
|
||||||
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
|
Considerations for licensors: Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. More considerations for licensors.
|
||||||
|
|
||||||
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
|
Considerations for the public: By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described. Although not required by our licenses, you are encouraged to respect those requests where reasonable. More considerations for the public.
|
||||||
|
|
||||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
Creative Commons Attribution-NonCommercial 4.0 International Public License
|
||||||
|
|
||||||
|
By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-NonCommercial 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.
|
||||||
|
|
||||||
|
Section 1 – Definitions.
|
||||||
|
|
||||||
|
a. Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image.
|
||||||
|
|
||||||
|
b. Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License.
|
||||||
|
|
||||||
|
c. Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
|
||||||
|
|
||||||
|
d. Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements.
|
||||||
|
|
||||||
|
e. Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material.
|
||||||
|
|
||||||
|
f. Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License.
|
||||||
|
|
||||||
|
g. Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license.
|
||||||
|
|
||||||
|
h. Licensor means the individual(s) or entity(ies) granting rights under this Public License.
|
||||||
|
|
||||||
|
i. NonCommercial means not primarily intended for or directed towards commercial advantage or monetary compensation. For purposes of this Public License, the exchange of the Licensed Material for other material subject to Copyright and Similar Rights by digital file-sharing or similar means is NonCommercial provided there is no payment of monetary compensation in connection with the exchange.
|
||||||
|
|
||||||
|
j. Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them.
|
||||||
|
|
||||||
|
k. Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world.
|
||||||
|
|
||||||
|
l. You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning.
|
||||||
|
|
||||||
|
Section 2 – Scope.
|
||||||
|
|
||||||
|
a. License grant.
|
||||||
|
|
||||||
|
1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to:
|
||||||
|
|
||||||
|
A. reproduce and Share the Licensed Material, in whole or in part, for NonCommercial purposes only; and
|
||||||
|
|
||||||
|
B. produce, reproduce, and Share Adapted Material for NonCommercial purposes only.
|
||||||
|
|
||||||
|
2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions.
|
||||||
|
|
||||||
|
3. Term. The term of this Public License is specified in Section 6(a).
|
||||||
|
|
||||||
|
4. Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material.
|
||||||
|
|
||||||
|
5. Downstream recipients.
|
||||||
|
|
||||||
|
A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License.
|
||||||
|
|
||||||
|
B. No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material.
|
||||||
|
|
||||||
|
6. No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i).
|
||||||
|
|
||||||
|
b. Other rights.
|
||||||
|
|
||||||
|
1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise.
|
||||||
|
|
||||||
|
2. Patent and trademark rights are not licensed under this Public License.
|
||||||
|
|
||||||
|
3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties, including when the Licensed Material is used other than for NonCommercial purposes.
|
||||||
|
|
||||||
|
Section 3 – License Conditions.
|
||||||
|
|
||||||
|
Your exercise of the Licensed Rights is expressly made subject to the following conditions.
|
||||||
|
|
||||||
|
a. Attribution.
|
||||||
|
|
||||||
|
1. If You Share the Licensed Material (including in modified form), You must:
|
||||||
|
|
||||||
|
A. retain the following if it is supplied by the Licensor with the Licensed Material:
|
||||||
|
|
||||||
|
i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated);
|
||||||
|
|
||||||
|
ii. a copyright notice;
|
||||||
|
|
||||||
|
iii. a notice that refers to this Public License;
|
||||||
|
|
||||||
|
iv. a notice that refers to the disclaimer of warranties;
|
||||||
|
|
||||||
|
v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
|
||||||
|
|
||||||
|
B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and
|
||||||
|
|
||||||
|
C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License.
|
||||||
|
|
||||||
|
2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information.
|
||||||
|
|
||||||
|
3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable.
|
||||||
|
|
||||||
|
4. If You Share Adapted Material You produce, the Adapter's License You apply must not prevent recipients of the Adapted Material from complying with this Public License.
|
||||||
|
|
||||||
|
Section 4 – Sui Generis Database Rights.
|
||||||
|
|
||||||
|
Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material:
|
||||||
|
|
||||||
|
a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database for NonCommercial purposes only;
|
||||||
|
|
||||||
|
b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material; and
|
||||||
|
|
||||||
|
c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database.
|
||||||
|
For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights.
|
||||||
|
|
||||||
|
Section 5 – Disclaimer of Warranties and Limitation of Liability.
|
||||||
|
|
||||||
|
a. Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.
|
||||||
|
|
||||||
|
b. To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.
|
||||||
|
|
||||||
|
c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.
|
||||||
|
|
||||||
|
Section 6 – Term and Termination.
|
||||||
|
|
||||||
|
a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically.
|
||||||
|
|
||||||
|
b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates:
|
||||||
|
|
||||||
|
1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or
|
||||||
|
|
||||||
|
2. upon express reinstatement by the Licensor.
|
||||||
|
|
||||||
|
For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License.
|
||||||
|
|
||||||
|
c. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License.
|
||||||
|
|
||||||
|
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
|
||||||
|
|
||||||
|
Section 7 – Other Terms and Conditions.
|
||||||
|
|
||||||
|
a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.
|
||||||
|
|
||||||
|
b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.
|
||||||
|
|
||||||
|
Section 8 – Interpretation.
|
||||||
|
|
||||||
|
a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License.
|
||||||
|
|
||||||
|
b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions.
|
||||||
|
|
||||||
|
c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor.
|
||||||
|
|
||||||
|
d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.
|
||||||
|
|
||||||
|
Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at creativecommons.org/policies, Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses.
|
||||||
|
|
||||||
|
Creative Commons may be contacted at creativecommons.org.
|
||||||
|
>>>>>>> origin/main
|
||||||
|
|||||||
465
README.md
465
README.md
@ -1,451 +1,26 @@
|
|||||||
# pi-gen
|
# MarineComOS RPI
|
||||||
|
|
||||||
Tool used to create Raspberry Pi OS images, and custom images based on Raspberry Pi OS,
|
MarineComOS RPI is a customized operating system for Raspberry Pi, designed specifically for marine applications. It is based on Raspberry Pi OS and built using pi-gen, with added configurations and tools to streamline onboard operations.
|
||||||
which was in turn derived from the Raspbian project.
|
|
||||||
|
|
||||||
**Note**: Raspberry Pi OS 32 bit images are based primarily on Raspbian, while
|
## Key Features
|
||||||
Raspberry Pi OS 64 bit images are based primarily on Debian.
|
- **Headless Operation**: SSH enabled by default with preconfigured networking.
|
||||||
|
- **Preloaded Docker Containers**:
|
||||||
|
- **Portainer** for container management.
|
||||||
|
- **SignalK** for marine data integration.
|
||||||
|
- **Filesystem Layout**:
|
||||||
|
- Read-only root filesystem for stability.
|
||||||
|
- Writable partition for Docker data and application dependencies.
|
||||||
|
|
||||||
**Note**: 32 bit images should be built from the `master` branch.
|
## Getting Started
|
||||||
64 bit images should be built from the `arm64` branch.
|
- **Download the Image**: Obtain the latest release from [MarineComOS RPI Releases](http://git.relentnet.com/Relentnet/MarineComOS_RPI).
|
||||||
|
- **Flash the Image**: Use tools like Raspberry Pi Imager or balenaEtcher to flash the `.img` file onto an SD card.
|
||||||
|
- **First Boot**: Insert the SD card into your Raspberry Pi and power it on.
|
||||||
|
|
||||||
## Dependencies
|
## Documentation
|
||||||
|
Detailed setup and usage instructions are available in the repository's [Wiki](http://git.relentnet.com/Relentnet/MarineComOS_RPI/wiki).
|
||||||
|
|
||||||
pi-gen runs on Debian-based operating systems released after 2017, and we
|
## Contributing
|
||||||
always advise you use the latest OS for security reasons.
|
Contributions are welcome! Open issues or submit pull requests for suggestions and improvements.
|
||||||
|
|
||||||
On other Linux distributions it may be possible to use the Docker build described
|
## License
|
||||||
below.
|
MarineComOS RPI is licensed under the MIT License. See [LICENSE](LICENSE) for details.
|
||||||
|
|
||||||
To install the required dependencies for `pi-gen` you should run:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
apt-get install coreutils quilt parted qemu-user-static debootstrap zerofree zip \
|
|
||||||
dosfstools libarchive-tools libcap2-bin grep rsync xz-utils file git curl bc \
|
|
||||||
gpg pigz xxd arch-test
|
|
||||||
```
|
|
||||||
|
|
||||||
The file `depends` contains a list of tools needed. The format of this
|
|
||||||
package is `<tool>[:<debian-package>]`.
|
|
||||||
|
|
||||||
## Getting started with building your images
|
|
||||||
|
|
||||||
Getting started is as simple as cloning this repository on your build machine. You
|
|
||||||
can do so with:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git clone https://github.com/RPI-Distro/pi-gen.git
|
|
||||||
```
|
|
||||||
|
|
||||||
`--depth 1` can be added after `git clone` to create a shallow clone, only containing
|
|
||||||
the latest revision of the repository. Do not do this on your development machine.
|
|
||||||
|
|
||||||
Also, be careful to clone the repository to a base path **NOT** containing spaces.
|
|
||||||
This configuration is not supported by debootstrap and will lead to `pi-gen` not
|
|
||||||
running.
|
|
||||||
|
|
||||||
After cloning the repository, you can move to the next step and start configuring
|
|
||||||
your build.
|
|
||||||
|
|
||||||
## Config
|
|
||||||
|
|
||||||
Upon execution, `build.sh` will source the file `config` in the current
|
|
||||||
working directory. This bash shell fragment is intended to set needed
|
|
||||||
environment variables.
|
|
||||||
|
|
||||||
The following environment variables are supported:
|
|
||||||
|
|
||||||
* `IMG_NAME` (Default: `raspios-$RELEASE-$ARCH`, for example: `raspios-bookworm-armhf`)
|
|
||||||
|
|
||||||
The name of the image to build with the current stage directories. Use this
|
|
||||||
variable to set the root name of your OS, eg `IMG_NAME=Frobulator`.
|
|
||||||
Export files in stages may add suffixes to `IMG_NAME`.
|
|
||||||
|
|
||||||
* `PI_GEN_RELEASE` (Default: `Raspberry Pi reference`)
|
|
||||||
|
|
||||||
The release name to use in `/etc/issue.txt`. The default should only be used
|
|
||||||
for official Raspberry Pi builds.
|
|
||||||
|
|
||||||
* `RELEASE` (Default: `bookworm`)
|
|
||||||
|
|
||||||
The release version to build images against. Valid values are any supported
|
|
||||||
Debian release. However, since different releases will have different sets of
|
|
||||||
packages available, you'll need to either modify your stages accordingly, or
|
|
||||||
checkout the appropriate branch. For example, if you'd like to build a
|
|
||||||
`bullseye` image, you should do so from the `bullseye` branch.
|
|
||||||
|
|
||||||
* `APT_PROXY` (Default: unset)
|
|
||||||
|
|
||||||
If you require the use of an apt proxy, set it here. This proxy setting
|
|
||||||
will not be included in the image, making it safe to use an `apt-cacher` or
|
|
||||||
similar package for development.
|
|
||||||
|
|
||||||
* `BASE_DIR` (Default: location of `build.sh`)
|
|
||||||
|
|
||||||
**CAUTION**: Currently, changing this value will probably break build.sh
|
|
||||||
|
|
||||||
Top-level directory for `pi-gen`. Contains stage directories, build
|
|
||||||
scripts, and by default both work and deployment directories.
|
|
||||||
|
|
||||||
* `WORK_DIR` (Default: `$BASE_DIR/work`)
|
|
||||||
|
|
||||||
Directory in which `pi-gen` builds the target system. This value can be
|
|
||||||
changed if you have a suitably large, fast storage location for stages to
|
|
||||||
be built and cached. Note, `WORK_DIR` stores a complete copy of the target
|
|
||||||
system for each build stage, amounting to tens of gigabytes in the case of
|
|
||||||
Raspbian.
|
|
||||||
|
|
||||||
**CAUTION**: If your working directory is on an NTFS partition you probably won't be able to build: make sure this is a proper Linux filesystem.
|
|
||||||
|
|
||||||
* `DEPLOY_DIR` (Default: `$BASE_DIR/deploy`)
|
|
||||||
|
|
||||||
Output directory for target system images and NOOBS bundles.
|
|
||||||
|
|
||||||
* `DEPLOY_COMPRESSION` (Default: `zip`)
|
|
||||||
|
|
||||||
Set to:
|
|
||||||
* `none` to deploy the actual image (`.img`).
|
|
||||||
* `zip` to deploy a zipped image (`.zip`).
|
|
||||||
* `gz` to deploy a gzipped image (`.img.gz`).
|
|
||||||
* `xz` to deploy a xzipped image (`.img.xz`).
|
|
||||||
|
|
||||||
|
|
||||||
* `DEPLOY_ZIP` (Deprecated)
|
|
||||||
|
|
||||||
This option has been deprecated in favor of `DEPLOY_COMPRESSION`.
|
|
||||||
|
|
||||||
If `DEPLOY_ZIP=0` is still present in your config file, the behavior is the
|
|
||||||
same as with `DEPLOY_COMPRESSION=none`.
|
|
||||||
|
|
||||||
* `COMPRESSION_LEVEL` (Default: `6`)
|
|
||||||
|
|
||||||
Compression level to be used when using `zip`, `gz` or `xz` for
|
|
||||||
`DEPLOY_COMPRESSION`. From 0 to 9 (refer to the tool man page for more
|
|
||||||
information on this. Usually 0 is no compression but very fast, up to 9 with
|
|
||||||
the best compression but very slow ).
|
|
||||||
|
|
||||||
* `USE_QEMU` (Default: `0`)
|
|
||||||
|
|
||||||
Setting to '1' enables the QEMU mode - creating an image that can be mounted via QEMU for an emulated
|
|
||||||
environment. These images include "-qemu" in the image file name.
|
|
||||||
|
|
||||||
* `LOCALE_DEFAULT` (Default: 'en_GB.UTF-8' )
|
|
||||||
|
|
||||||
Default system locale.
|
|
||||||
|
|
||||||
* `TARGET_HOSTNAME` (Default: 'raspberrypi' )
|
|
||||||
|
|
||||||
Setting the hostname to the specified value.
|
|
||||||
|
|
||||||
* `KEYBOARD_KEYMAP` (Default: 'gb' )
|
|
||||||
|
|
||||||
Default keyboard keymap.
|
|
||||||
|
|
||||||
To get the current value from a running system, run `debconf-show
|
|
||||||
keyboard-configuration` and look at the
|
|
||||||
`keyboard-configuration/xkb-keymap` value.
|
|
||||||
|
|
||||||
* `KEYBOARD_LAYOUT` (Default: 'English (UK)' )
|
|
||||||
|
|
||||||
Default keyboard layout.
|
|
||||||
|
|
||||||
To get the current value from a running system, run `debconf-show
|
|
||||||
keyboard-configuration` and look at the
|
|
||||||
`keyboard-configuration/variant` value.
|
|
||||||
|
|
||||||
* `TIMEZONE_DEFAULT` (Default: 'Europe/London' )
|
|
||||||
|
|
||||||
Default time zone.
|
|
||||||
|
|
||||||
To get the current value from a running system, look in
|
|
||||||
`/etc/timezone`.
|
|
||||||
|
|
||||||
* `FIRST_USER_NAME` (Default: `pi`)
|
|
||||||
|
|
||||||
Username for the first user. This user only exists during the image creation process. Unless
|
|
||||||
`DISABLE_FIRST_BOOT_USER_RENAME` is set to `1`, this user will be renamed on the first boot with
|
|
||||||
a name chosen by the final user. This security feature is designed to prevent shipping images
|
|
||||||
with a default username and help prevent malicious actors from taking over your devices.
|
|
||||||
|
|
||||||
* `FIRST_USER_PASS` (Default: unset)
|
|
||||||
|
|
||||||
Password for the first user. If unset, the account is locked.
|
|
||||||
|
|
||||||
* `DISABLE_FIRST_BOOT_USER_RENAME` (Default: `0`)
|
|
||||||
|
|
||||||
Disable the renaming of the first user during the first boot. This make it so `FIRST_USER_NAME`
|
|
||||||
stays activated. `FIRST_USER_PASS` must be set for this to work. Please be aware of the implied
|
|
||||||
security risk of defining a default username and password for your devices.
|
|
||||||
|
|
||||||
* `WPA_COUNTRY` (Default: unset)
|
|
||||||
|
|
||||||
Sets the default WLAN regulatory domain and unblocks WLAN interfaces. This should be a 2-letter ISO/IEC 3166 country Code, i.e. `GB`
|
|
||||||
|
|
||||||
* `ENABLE_SSH` (Default: `0`)
|
|
||||||
|
|
||||||
Setting to `1` will enable ssh server for remote log in. Note that if you are using a common password such as the defaults there is a high risk of attackers taking over you Raspberry Pi.
|
|
||||||
|
|
||||||
* `PUBKEY_SSH_FIRST_USER` (Default: unset)
|
|
||||||
|
|
||||||
Setting this to a value will make that value the contents of the FIRST_USER_NAME's ~/.ssh/authorized_keys. Obviously the value should
|
|
||||||
therefore be a valid authorized_keys file. Note that this does not
|
|
||||||
automatically enable SSH.
|
|
||||||
|
|
||||||
* `PUBKEY_ONLY_SSH` (Default: `0`)
|
|
||||||
|
|
||||||
* Setting to `1` will disable password authentication for SSH and enable
|
|
||||||
public key authentication. Note that if SSH is not enabled this will take
|
|
||||||
effect when SSH becomes enabled.
|
|
||||||
|
|
||||||
* `SETFCAP` (Default: unset)
|
|
||||||
|
|
||||||
* Setting to `1` will prevent pi-gen from dropping the "capabilities"
|
|
||||||
feature. Generating the root filesystem with capabilities enabled and running
|
|
||||||
it from a filesystem that does not support capabilities (like NFS) can cause
|
|
||||||
issues. Only enable this if you understand what it is.
|
|
||||||
|
|
||||||
* `STAGE_LIST` (Default: `stage*`)
|
|
||||||
|
|
||||||
If set, then instead of working through the numeric stages in order, this list will be followed. For example setting to `"stage0 stage1 mystage stage2"` will run the contents of `mystage` before stage2. Note that quotes are needed around the list. An absolute or relative path can be given for stages outside the pi-gen directory.
|
|
||||||
|
|
||||||
* `EXPORT_CONFIG_DIR` (Default: `$BASE_DIR/export-image`)
|
|
||||||
|
|
||||||
If set, use this directory path as the location of scripts to run when generating images. An absolute or relative path can be given for a location outside the pi-gen directory.
|
|
||||||
|
|
||||||
A simple example for building Raspberry Pi OS:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
IMG_NAME='raspios'
|
|
||||||
```
|
|
||||||
|
|
||||||
The config file can also be specified on the command line as an argument the `build.sh` or `build-docker.sh` scripts.
|
|
||||||
|
|
||||||
```
|
|
||||||
./build.sh -c myconfig
|
|
||||||
```
|
|
||||||
|
|
||||||
This is parsed after `config` so can be used to override values set there.
|
|
||||||
|
|
||||||
## How the build process works
|
|
||||||
|
|
||||||
The following process is followed to build images:
|
|
||||||
|
|
||||||
* Iterate through all of the stage directories in alphanumeric order
|
|
||||||
|
|
||||||
* Bypass a stage directory if it contains a file called
|
|
||||||
"SKIP"
|
|
||||||
|
|
||||||
* Run the script `prerun.sh` which is generally just used to copy the build
|
|
||||||
directory between stages.
|
|
||||||
|
|
||||||
* In each stage directory iterate through each subdirectory and then run each of the
|
|
||||||
install scripts it contains, again in alphanumeric order. **These need to be named
|
|
||||||
with a two digit padded number at the beginning.**
|
|
||||||
There are a number of different files and directories which can be used to
|
|
||||||
control different parts of the build process:
|
|
||||||
|
|
||||||
- **00-run.sh** - A unix shell script. Needs to be made executable for it to run.
|
|
||||||
|
|
||||||
- **00-run-chroot.sh** - A unix shell script which will be run in the chroot
|
|
||||||
of the image build directory. Needs to be made executable for it to run.
|
|
||||||
|
|
||||||
- **00-debconf** - Contents of this file are passed to debconf-set-selections
|
|
||||||
to configure things like locale, etc.
|
|
||||||
|
|
||||||
- **00-packages** - A list of packages to install. Can have more than one, space
|
|
||||||
separated, per line.
|
|
||||||
|
|
||||||
- **00-packages-nr** - As 00-packages, except these will be installed using
|
|
||||||
the `--no-install-recommends -y` parameters to apt-get.
|
|
||||||
|
|
||||||
- **00-patches** - A directory containing patch files to be applied, using quilt.
|
|
||||||
If a file named 'EDIT' is present in the directory, the build process will
|
|
||||||
be interrupted with a bash session, allowing an opportunity to create/revise
|
|
||||||
the patches.
|
|
||||||
|
|
||||||
* If the stage directory contains files called "EXPORT_NOOBS" or "EXPORT_IMAGE" then
|
|
||||||
add this stage to a list of images to generate
|
|
||||||
|
|
||||||
* Generate the images for any stages that have specified them
|
|
||||||
|
|
||||||
It is recommended to examine build.sh for finer details.
|
|
||||||
|
|
||||||
|
|
||||||
## Docker Build
|
|
||||||
|
|
||||||
Docker can be used to perform the build inside a container. This partially isolates
|
|
||||||
the build from the host system, and allows using the script on non-debian based
|
|
||||||
systems (e.g. Fedora Linux). The isolation is not complete due to the need to use
|
|
||||||
some kernel level services for arm emulation (binfmt) and loop devices (losetup).
|
|
||||||
|
|
||||||
To build:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
vi config # Edit your config file. See above.
|
|
||||||
./build-docker.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
If everything goes well, your finished image will be in the `deploy/` folder.
|
|
||||||
You can then remove the build container with `docker rm -v pigen_work`
|
|
||||||
|
|
||||||
If you encounter errors during the build, you can edit the corresponding scripts, and
|
|
||||||
continue:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
CONTINUE=1 ./build-docker.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
To examine the container after a failure you can enter a shell within it using:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
sudo docker run -it --privileged --volumes-from=pigen_work pi-gen /bin/bash
|
|
||||||
```
|
|
||||||
|
|
||||||
After successful build, the build container is by default removed. This may be undesired when making incremental changes to a customized build. To prevent the build script from remove the container add
|
|
||||||
|
|
||||||
```bash
|
|
||||||
PRESERVE_CONTAINER=1 ./build-docker.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
There is a possibility that even when running from a docker container, the
|
|
||||||
installation of `qemu-user-static` will silently fail when building the image
|
|
||||||
because `binfmt-support` _must be enabled on the underlying kernel_. An easy
|
|
||||||
fix is to ensure `binfmt-support` is installed on the host machine before
|
|
||||||
starting the `./build-docker.sh` script (or using your own docker build
|
|
||||||
solution).
|
|
||||||
|
|
||||||
### Passing arguments to Docker
|
|
||||||
|
|
||||||
When the docker image is run various required command line arguments are provided. For example the system mounts the `/dev` directory to the `/dev` directory within the docker container. If other arguments are required they may be specified in the PIGEN_DOCKER_OPTS environment variable. For example setting `PIGEN_DOCKER_OPTS="--add-host foo:192.168.0.23"` will add '192.168.0.23 foo' to the `/etc/hosts` file in the container. The `--name`
|
|
||||||
and `--privileged` options are already set by the script and should not be redefined.
|
|
||||||
|
|
||||||
## Stage Anatomy
|
|
||||||
|
|
||||||
### Raspbian Stage Overview
|
|
||||||
|
|
||||||
The build of Raspbian is divided up into several stages for logical clarity
|
|
||||||
and modularity. This causes some initial complexity, but it simplifies
|
|
||||||
maintenance and allows for more easy customization.
|
|
||||||
|
|
||||||
- **Stage 0** - bootstrap. The primary purpose of this stage is to create a
|
|
||||||
usable filesystem. This is accomplished largely through the use of
|
|
||||||
`debootstrap`, which creates a minimal filesystem suitable for use as a
|
|
||||||
base.tgz on Debian systems. This stage also configures apt settings and
|
|
||||||
installs `raspberrypi-bootloader` which is missed by debootstrap. The
|
|
||||||
minimal core is installed but not configured. As a result, this stage will not boot.
|
|
||||||
|
|
||||||
- **Stage 1** - truly minimal system. This stage makes the system bootable by
|
|
||||||
installing system files like `/etc/fstab`, configures the bootloader, makes
|
|
||||||
the network operable, and installs packages like raspi-config. At this
|
|
||||||
stage the system should boot to a local console from which you have the
|
|
||||||
means to perform basic tasks needed to configure and install the system.
|
|
||||||
|
|
||||||
- **Stage 2** - lite system. This stage produces the Raspberry Pi OS Lite image.
|
|
||||||
Stage 2 installs some optimized memory functions, sets timezone and charmap
|
|
||||||
defaults, installs fake-hwclock and ntp, wireless LAN and bluetooth support,
|
|
||||||
dphys-swapfile, and other basics for managing the hardware. It also
|
|
||||||
creates necessary groups and gives the pi user access to sudo and the
|
|
||||||
standard console hardware permission groups.
|
|
||||||
|
|
||||||
Note: Raspberry Pi OS Lite contains a number of tools for development,
|
|
||||||
including `Python`, `Lua` and the `build-essential` package. If you are
|
|
||||||
creating an image to deploy in products, be sure to remove extraneous development
|
|
||||||
tools before deployment.
|
|
||||||
|
|
||||||
- **Stage 3** - desktop system. Here's where you get the full desktop system
|
|
||||||
with X11 and LXDE, web browsers, git for development, Raspberry Pi OS custom UI
|
|
||||||
enhancements, etc. This is a base desktop system, with some development
|
|
||||||
tools installed.
|
|
||||||
|
|
||||||
- **Stage 4** - Normal Raspberry Pi OS image. System meant to fit on a 4GB card.
|
|
||||||
This is the stage that installs most things that make Raspberry Pi OS friendly
|
|
||||||
to new users - e.g. system documentation.
|
|
||||||
|
|
||||||
- **Stage 5** - The Raspberry Pi OS Full image. More development
|
|
||||||
tools, an email client, learning tools like Scratch, specialized packages
|
|
||||||
like sonic-pi, office productivity, etc.
|
|
||||||
|
|
||||||
### Stage specification
|
|
||||||
|
|
||||||
If you wish to build up to a specified stage (such as building up to stage 2
|
|
||||||
for a lite system), place an empty file named `SKIP` in each of the `./stage`
|
|
||||||
directories you wish not to include.
|
|
||||||
|
|
||||||
Then add an empty file named `SKIP_IMAGES` to `./stage4` and `./stage5` (if building up to stage 2) or
|
|
||||||
to `./stage2` (if building a minimal system).
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Example for building a lite system
|
|
||||||
echo "IMG_NAME='raspios'" > config
|
|
||||||
touch ./stage3/SKIP ./stage4/SKIP ./stage5/SKIP
|
|
||||||
touch ./stage4/SKIP_IMAGES ./stage5/SKIP_IMAGES
|
|
||||||
sudo ./build.sh # or ./build-docker.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
If you wish to build further configurations upon (for example) the lite
|
|
||||||
system, you can also delete the contents of `./stage3` and `./stage4` and
|
|
||||||
replace with your own contents in the same format.
|
|
||||||
|
|
||||||
|
|
||||||
## Skipping stages to speed up development
|
|
||||||
|
|
||||||
If you're working on a specific stage the recommended development process is as
|
|
||||||
follows:
|
|
||||||
|
|
||||||
* Add a file called SKIP_IMAGES into the directories containing EXPORT_* files
|
|
||||||
(currently stage2, stage4 and stage5)
|
|
||||||
* Add SKIP files to the stages you don't want to build. For example, if you're
|
|
||||||
basing your image on the lite image you would add these to stages 3, 4 and 5.
|
|
||||||
* Run build.sh to build all stages
|
|
||||||
* Add SKIP files to the earlier successfully built stages
|
|
||||||
* Modify the last stage
|
|
||||||
* Rebuild just the last stage using `sudo CLEAN=1 ./build.sh` (or, for docker builds
|
|
||||||
`PRESERVE_CONTAINER=1 CONTINUE=1 CLEAN=1 ./build-docker.sh`)
|
|
||||||
* Once you're happy with the image you can remove the SKIP_IMAGES files and
|
|
||||||
export your image to test
|
|
||||||
|
|
||||||
# Troubleshooting
|
|
||||||
|
|
||||||
## `64 Bit Systems`
|
|
||||||
A 64 bit image can be generated from the `arm64` branch in this repository. Just
|
|
||||||
replace the command from [this section](#getting-started-with-building-your-images)
|
|
||||||
by the one below, and follow the rest of the documentation:
|
|
||||||
```bash
|
|
||||||
git clone --branch arm64 https://github.com/RPI-Distro/pi-gen.git
|
|
||||||
```
|
|
||||||
|
|
||||||
If you want to generate a 64 bits image from a Raspberry Pi running a 32 bits
|
|
||||||
version, you need to add `arm_64bit=1` to your `config.txt` file and reboot your
|
|
||||||
machine. This will restart your machine with a 64 bits kernel. This will only
|
|
||||||
work from a Raspberry Pi with a 64-bit capable processor (i.e. Raspberry Pi Zero
|
|
||||||
2, Raspberry Pi 3 or Raspberry Pi 4).
|
|
||||||
|
|
||||||
|
|
||||||
## `binfmt_misc`
|
|
||||||
|
|
||||||
Linux is able to execute binaries from other architectures, meaning that it should be
|
|
||||||
possible to make use of `pi-gen` on an x86_64 system, even though it will be running
|
|
||||||
ARM binaries. This requires support from the [`binfmt_misc`](https://en.wikipedia.org/wiki/Binfmt_misc)
|
|
||||||
kernel module.
|
|
||||||
|
|
||||||
You may see one of the following errors:
|
|
||||||
|
|
||||||
```
|
|
||||||
update-binfmts: warning: Couldn't load the binfmt_misc module.
|
|
||||||
```
|
|
||||||
```
|
|
||||||
W: Failure trying to run: chroot "/pi-gen/work/test/stage0/rootfs" /bin/true
|
|
||||||
and/or
|
|
||||||
chroot: failed to run command '/bin/true': Exec format error
|
|
||||||
```
|
|
||||||
|
|
||||||
To resolve this, ensure that the following files are available (install them if necessary):
|
|
||||||
|
|
||||||
```
|
|
||||||
/lib/modules/$(uname -r)/kernel/fs/binfmt_misc.ko
|
|
||||||
/usr/bin/qemu-arm-static
|
|
||||||
```
|
|
||||||
|
|
||||||
You may also need to load the module by hand - run `modprobe binfmt_misc`.
|
|
||||||
|
|
||||||
If you are using WSL to build you may have to enable the service `sudo update-binfmts --enable`
|
|
||||||
|
|||||||
@ -1,4 +1,3 @@
|
|||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
# Load pre-downloaded Docker images
|
|
||||||
docker load < /docker-images/portainer.tar
|
docker load < /docker-images/portainer.tar
|
||||||
docker load < /docker-images/signalr.tar
|
docker load < /docker-images/signalk.tar
|
||||||
|
|||||||
4
stage2/01-marinecomos-setup/files/etc/start-portainer-container.sh
Executable file
4
stage2/01-marinecomos-setup/files/etc/start-portainer-container.sh
Executable file
@ -0,0 +1,4 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
docker run -d --name portainer --restart=always -p 9000:9000 \
|
||||||
|
-v /var/run/docker.sock:/var/run/docker.sock \
|
||||||
|
-v /data:/data portainer/portainer-ce
|
||||||
3
stage2/01-marinecomos-setup/files/etc/start-signalk-container.sh
Executable file
3
stage2/01-marinecomos-setup/files/etc/start-signalk-container.sh
Executable file
@ -0,0 +1,3 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
docker run -d --name signalk --restart=always -p 3000:3000 \
|
||||||
|
-v /var/lib/signalk:/data signalk/signalk-server
|
||||||
@ -0,0 +1,11 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Preload Docker Images
|
||||||
|
After=docker.service
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=oneshot
|
||||||
|
ExecStart=/etc/preload-docker-images.sh
|
||||||
|
RemainAfterExit=true
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
@ -1,11 +1,11 @@
|
|||||||
[Unit]
|
[Unit]
|
||||||
Description=Start Docker Containers on First Boot
|
Description=Start Docker Containers
|
||||||
After=docker.service
|
After=docker.service
|
||||||
Requires=docker.service
|
|
||||||
|
|
||||||
[Service]
|
[Service]
|
||||||
Type=oneshot
|
Type=oneshot
|
||||||
ExecStart=/etc/start-docker-containers.sh
|
ExecStart=/etc/start-portainer-container.sh
|
||||||
|
ExecStart=/etc/start-signalk-container.sh
|
||||||
RemainAfterExit=true
|
RemainAfterExit=true
|
||||||
|
|
||||||
[Install]
|
[Install]
|
||||||
|
|||||||
@ -1,2 +1,3 @@
|
|||||||
docker load < /docker-images/signalk.tar
|
#!/bin/bash
|
||||||
docker load < /docker-images/portainer.tar
|
docker load < /docker-images/portainer.tar
|
||||||
|
docker load < /docker-images/signalk.tar
|
||||||
|
|||||||
@ -1,4 +1,4 @@
|
|||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
# Start Portainer container
|
|
||||||
docker run -d --name portainer --restart=always -p 9000:9000 \
|
docker run -d --name portainer --restart=always -p 9000:9000 \
|
||||||
-v /var/run/docker.sock:/var/run/docker.sock -v portainer_data:/data portainer/portainer-ce:latest
|
-v /var/run/docker.sock:/var/run/docker.sock \
|
||||||
|
-v /data:/data portainer/portainer-ce
|
||||||
|
|||||||
@ -1,4 +1,3 @@
|
|||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
# Start SignalK container
|
|
||||||
docker run -d --name signalk --restart=always -p 3000:3000 \
|
docker run -d --name signalk --restart=always -p 3000:3000 \
|
||||||
-v /var/lib/signalk:/data signalk/signalk-server
|
-v /var/lib/signalk:/data signalk/signalk-server
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user