RaspAP / raspap-webgui

Simple wireless AP setup & management for Debian-based devices
https://raspap.com/
GNU General Public License v3.0
4.48k stars 794 forks source link

Use pi-gen-action to build 32- and 64-bit RaspAP images #1688

Open billz opened 3 weeks ago

billz commented 3 weeks ago

Is your feature request related to a problem?

Many users have requested a 32- or 64-bit Lite (bookworm) SD card image with a RaspAP installation. A pre-built image achieves two goals:

  1. Faster setups without first following the project perquisites and executing the installer.
  2. Eliminates potential conflicts and troubleshooting when installing RaspAP on a non-clean OS.

Describe the solution you'd like

The pi-gen-action wraps pi-gen to make it easily accessible in GitHub workflows. Generated images can subsequently be used in workflows, e.g. uploaded as build artifacts or further processed. pi-gen is the official tool to generate Raspberry Pi OS images that can be flashed on SD cards. A custom user stage may be defined to execute RaspAP's quick installer with the following optional flags (1 = enabled):

-o, --openvpn <flag>
-s, --rest, --restapi <flag>
-a, --adblock <flag>
-w, --wireguard <flag>
-g, --tcp-bbr <flag>

example: curl -sL https://install.raspap.com | bash -s -- --yes --openvpn 1 --restapi 1 --adblock 1 --wireguard 1 --tcp-bbr 1

After booting the OS with RaspAP, the user may then opt to disable any of these components that aren't needed.

The build will be triggered whenever the master branch of the /RaspAP/raspap-webgui repository is updated. For a repo other than the current one, this can be done with a repository dispatch event and triggered by a webhook. Generated images will be uploaded as artifacts that are accessible to end users.

Describe alternatives you've considered

While not a strict requirement, pi-gen-action appears to provide a beaten path to creating the desired GitHub workflow.

Additional context

Refer to the pi-gen repository for detailed information on the scripts and its usage.

algora-pbc[bot] commented 3 weeks ago

💎 $300 bounty • RaspAP

Steps to solve:

  1. Start working: Comment /attempt #1688 with your implementation plan
  2. Submit work: Create a pull request including /claim #1688 in the PR body to claim the bounty
  3. Receive payment: 100% of the bounty is received 2-5 days post-reward. Make sure you are eligible for payouts

Thank you for contributing to RaspAP/raspap-webgui!

Add a bounty • Share on socials

Attempt Started (GMT+0) Solution
🟢 @NL-TCH Oct 31, 2024, 9:58:57 AM #1689
🟢 @Dhanus3133 Oct 31, 2024, 10:07:20 AM #1690
billz commented 3 weeks ago

@NL-TCH @glaszig possibly of interest :)

NL-TCH commented 3 weeks ago

/attempt #1688

Algora profile Completed bounties Tech Active attempts Options
@NL-TCH 1 RaspAP bounty
TypeScript, C++,
Python & more
Cancel attempt
Dhanus3133 commented 3 weeks ago

/attempt #1688

Algora profile Completed bounties Tech Active attempts Options
@Dhanus3133 15 bounties from 6 projects
Python, Rust,
Shell & more
Cancel attempt
algora-pbc[bot] commented 3 weeks ago

💡 @Dhanus3133 submitted a pull request that claims the bounty. You can visit your bounty board to reward.