Skip to content

Commit

Permalink
Merge branch 'master' into donationpage
Browse files Browse the repository at this point in the history
  • Loading branch information
rootzoll authored Nov 7, 2024
2 parents 23a8f0c + 6da761e commit b26ff32
Show file tree
Hide file tree
Showing 20 changed files with 6,411 additions and 4,028 deletions.
8 changes: 4 additions & 4 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ jobs:
permissions:
contents: write
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 18
node-version: 20
cache: yarn

- name: Install dependencies
Expand All @@ -28,7 +28,7 @@ jobs:
# Popular action to deploy to GitHub Pages:
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Build output to publish to the `gh-pages` branch:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/spelling.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout Actions Repository
uses: actions/checkout@v3
uses: actions/checkout@v4
- name: Spell Check Repo
uses: crate-ci/typos@master
with:
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/test-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ jobs:
name: Test deployment
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 18
node-version: 20
cache: yarn

- name: Install dependencies
Expand Down
8 changes: 8 additions & 0 deletions .idea/.gitignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

56 changes: 13 additions & 43 deletions docs/faq/dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,13 @@ The RaspiBlitz is your computer to experiment with. Feel free to add your own sc

### Can I run RaspiBlitz on other computers than RaspberryPi?

There is an experimental section in this GitHub that tries to build for other SingleBoardComputers. Feel free to try it out and share your experience: [alternative.platforms/README.md](https://github.com/raspiblitz/raspiblitz/blob/dev/alternative.platforms/README.md)
Yes. The build script `build_sdcard.sh` (in the root of the raspiblitz repo) has the goal to be able to turn a fresh setup of the Linux distribution [Debian](https://cdimage.debian.org/cdimage/) (use latest release) into a RaspiBlitz system. Login as root and run:

`wget --no-cache https://raw.githubusercontent.com/raspiblitz/raspiblitz/dev/build_sdcard.sh && bash build_sdcard.sh -u raspiblitz -b dev -f 0 -d headless`

You can replace the first `raspiblitz` in the URL & after parameter `-u` with your github username and `dev` (replace 2 times) the the branch you want to build the system from.

There is also an experimental section in the raspiblitz repo that tries to build for other SingleBoardComputers. Feel free to try it out and share your experience: [alternative.platforms/README.md](https://github.com/raspiblitz/raspiblitz/blob/dev/alternative.platforms/README.md)

### How can I build an SD card from another branch?

Expand All @@ -190,31 +196,17 @@ Once the branch is available and synced between the RaspiBlitz GitHub repo, your

### How can I sync a branch of my forked GitHub with my local RaspiBlitz?

Since v1.5 of RaspiBlitz there has been an easy way thru the SSH menus: Under `MAIN MENU > UPDATE > PATCH` you have the option to change the GitHub repository and and branch to sync with. You change the GitHub Repository by setting the GitHub username where you forked the Repo.

So for example: If you forked the RaspiBlitz project (raspiblitz/raspiblitz) on GitHub and your GitHub project page is now called: https://github.com/raumi75/raspiblitz ... then just change the repo to sync/patch with to your username `raumi75`.

Now you can use the `Patch/Sync RaspiBlitz with GitHub Repo` to easily keep your RaspiBlitz in sync with your forked repository and develop your own customizations and features.

Background info and doing it manually:
On the terminal use the command `github` and a menu shows up. Change the `REPO` to your forked Github repo. And then use `BRANCH` from that menu to set the branch your are working in.

There is a git copy of the original RaspiBlitz GitHub repo on your physical RaspiBlitz in the folder `/home/admin/raspiblitz`. If you change into that folder and run `git remote -v` you can see the set origin repo.

You need to change that origin repo to your forked repo. You do that with:
```
git remote set-url origin [THE-URL-OF-YOUR-FORKED-REPO]
```

Now to sync your branch namend BRANCH on your forked repo with your RaspiBlitz, you always just run:
```
/home/admin/config.scripts/blitz.github.sh BRANCH
```
You can the always use `PATCH` from that menu if you want to sync the scripts of your RaspiBlitz with the latest version of the scripts in your forked repo & branch. You can also use the terminal command `patch code` diretcly to trigger the sync.

So your workflow can go like this: You write code on your local computer. Commit to your local repo, push it to your forked repo and use the sync-script above to get the code to your RaspiBlitz.

### How can I manual provision an image with updated code?

To boot an already build sd card image with your updated raspiblitz code base you can use the `stop` file flag. This will make the `_bootstrap.sh` script stop basically before making any setup or recovery changes to the system. You can SSH in an use the `github` command to update the raspiblitz code and then use `release` command. To set the `stop` file flag. Insert a fresh written sd card into your PC and on the root of `bootfs` drive with a file manager place a empty file simply called `stop` (with no file extension).
For RaspberryPi: To boot an already build sd card image with your updated raspiblitz code base you can use the `stop` file flag. This will make the `_bootstrap.sh` script stop basically before making any setup or recovery changes to the system. You can SSH in an use the `github` command to update the raspiblitz code and then use `release` command. To set the `stop` file flag. Insert a fresh written sd card into your PC and on the root of `bootfs` drive with a file manager place a empty file simply called `stop` (with no file extension).

For VMs/Proxmox (since 1.11.3): If you wanna stop the bootstrap of a RaspiBlitz running in a VM you can add an "Audio Device" to it. If RaspiBlitz is running in a VM and an audio device it will stop for manual provision. So you just need to build your RaspiBlitz VM once, than have it as a template with an added audio device and just clone it, start it, SSH in to provision updated code (change to another branch or PR you want to test) and then use `release` to shutdown. Remove the audio device and your good to go. Under Proxmox on your VM under `Hardware` just add any of the three basic emulated audio devices available - just choose `driver=none`.

### How to add an app to the RaspiBlitz?

Expand All @@ -228,34 +220,12 @@ See more info: https://yangsu.github.io/pull-request-tutorial/

### How can I help testing a Pull Request?

Make sure to have the correct base image.
Then go to the command line and create a branch for the PR:

```
cd /home/admin/raspiblitz
git fetch origin pull/[PRNUMBER]/head:pr[PRNUMBER]
git checkout pr[PRNUMBER]
cd /home/admin
/home/admin/config.scripts/blitz.github.sh -justinstall
```

Now you have the code of the PR active - depending on what scripts are changed you might need to reboot.

To change back to the code:
```
/home/admin/config.scripts/blitz.github.sh master
```
On the terminal use command 'github' (make sure your on the main raspiblitz repo). In the menu choose `PR` and enter the issue number of the pull request. Then your scripts will sync to the state of the PR and you can test it. If your done - use command `github` again and change `BRANCH` back to dev or the latest release.

### How can I push changes to an existing Pull Request?

See article: https://tech.sycamore.garden/add-commit-push-contributor-branch-git-github .. only works if your a contributor on raspiblitz repo.

### How to cherry-pick with branch protections & CODEOWNERS file?

Chery-picking patch PRs from dev to a release-branch like 'v1.8' (for example) is now a bit more complicated. Either an admin switches temorarly the branch protection "require a pull request before merging" setting off for the `git cherry-pick` OR we create a `p1.8` branch from `v1.8`, cherry-pick the squashed patch PR into that unprotected `p1.8` and then open a PR back to `v1.8`.

But what we gain is that better branch protection and we can add more contributors to the project that are allowed to manage issues - like adding labels or closing.

### How to run the automatic amd64 build on a VM on OSX?

just notes so far:
Expand Down
2 changes: 1 addition & 1 deletion docs/setup/software-setup/1_download.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This is the sd card image you should choose if your at the beginning of your Ras
- **FATPACK SD CARD IMAGE ⮕ [raspiblitz-fat-v1.11.2-2024-08-15.img.gz](https://raspiblitz.fulmo.org/images/raspiblitz-fat-v1.11.2-2024-08-15.img.gz)**
- SHA-256: f784b750473ee6dd61d09d67c728ecf5d53b660e00f98285b0ffcb1ee7a6dea6
- GPG 64-bit (main): 1C73 060C 7C17 6461 & (sub): AA9D D1B5 CC56 47DA
- Signature-File: [raspiblitz-fat-v1.11.1-2024-07-31.img.gz.sig](https://raspiblitz.fulmo.org/images/raspiblitz-fat-v1.11.2-2024-08-15.img.gz.sig)
- Signature-File: [raspiblitz-fat-v1.11.2-2024-08-15.img.gz.sig](https://raspiblitz.fulmo.org/images/raspiblitz-fat-v1.11.2-2024-08-15.img.gz.sig)
- Torrent: [raspiblitz-fat-v1.11.2-2024-08-15.img.gz.torrent](https://github.com/raspiblitz/raspiblitz/raw/v1.11/home.admin/assets/raspiblitz-fat-v1.11.2-2024-08-15.img.gz.torrent)
- [How to verify the SD card image after download?](../../faq/faq.md#how-to-verify-the-sd-card-image-after-download)

Expand Down
8 changes: 8 additions & 0 deletions docs/shops.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Shops

You can buy a pre-built RaspiBlitz on the following shops:

- [DIYnodes.com](https://diynodes.com/)
- [yourdevice.ch](https://yourdevice.ch/produkt-kategorie/btc-nodes-zubehoer/)

If you would like to have your shop listed, please contact us.
9 changes: 6 additions & 3 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
// See: https://docusaurus.io/docs/api/docusaurus-config

import { themes as prismThemes } from "prism-react-renderer";
import tailwindPlugin from "./plugins/tailwind-config.cjs";

/** @type {import('@docusaurus/types').Config} */
const config = {
Expand Down Expand Up @@ -54,6 +55,8 @@ const config = {
],
],

plugins: [tailwindPlugin],

themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
Expand All @@ -65,7 +68,7 @@ const config = {
// Replace with your project's social card
image: "img/docusaurus-social-card.jpg",
navbar: {
title: "RaspiBlitz",
title: "",
logo: {
alt: "RaspiBlitz logo",
src: "img/RaspiBlitz_Logo_Main_Negative.svg",
Expand All @@ -75,7 +78,7 @@ const config = {
type: "docSidebar",
sidebarId: "blitzSidebar",
position: "left",
label: "Tutorial",
label: "Documentation",
},
{
href: "https://github.com/raspiblitz/raspiblitz",
Expand All @@ -92,7 +95,7 @@ const config = {
footer: {
style: "dark",
links: [],
copyright: `Copyright © ${new Date().getFullYear()} RaspiBlitz open source project. Built with Docusaurus.`,
copyright: `Copyright © ${new Date().getFullYear()} RaspiBlitz open source project. Built with Docusaurus. Impressum: Christian Rotzoll, christian [ at ] rotzoll.de - this site is not using any cookies and is not storing your data. Icons by https://fontawesome.com/ (CC BY 4.0) and https://lucide.dev/ (ISC)`,
},
prism: {
theme: prismThemes.github,
Expand Down
Loading

0 comments on commit b26ff32

Please sign in to comment.