https://github.com/damdo/gokrazy-on-qemu

A qemu setup to develop for the gokrazy (https://gokrazy.org) ecosystem
https://github.com/damdo/gokrazy-on-qemu

Last synced: 26 days ago
JSON representation

A qemu setup to develop for the gokrazy (https://gokrazy.org) ecosystem

• Host: GitHub
• URL: https://github.com/damdo/gokrazy-on-qemu
• Owner: damdo
• Created: 2022-04-27T18:38:10.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-17T18:02:16.000Z (almost 2 years ago)
• Last Synced: 2023-03-02T08:02:35.205Z (over 1 year ago)
• Language: Shell
• Homepage:
• Size: 1.26 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## gokrazy-on-qemu

A qemu setup to develop for the [gokrazy](https://gokrazy.org) ecosystem.

To set this up, you can choose:

- to run this directly on your machine. To do so make sure your machine has all the following requirements

  - `qemu` >= `7.1.0`

  - `go` >= `1.18`

  - `zip`

  - `sed`

  You can then follow along with the other steps, but skip the `ENVIRONMENT` section.

- to run this within a dedicated Ubuntu VM (VirtualBox) that can be created for you by Vagrant.

  - just follow along all the steps.

```bash

##### 1) OBTAIN

# Obtain this repo by:

git clone https://github.com/damdo/gokrazy-on-qemu

cd gokrazy-on-qemu/

##### 2) ENVIRONMENT

# Tweak the Vagrantfile to your specific environment

# e.g. update the networking bits to match your network card

# or just ignore the vagrant bits if you have an environment

# already properly setup for qemu.

# Provision the vm.

vagrant up

# SSH into the vm.

vagrant ssh

cd gokrazy-on-qemu/

##### 3) BUILD and RUN

# Build the drive.img the first time.

# Available values for 'GOARCH' are: amd64, arm64

# Available values for 'GOOS' are: linux, darwin

GOARCH= GOOS= ./build.sh

# Run the emulation machine.

# Available values for 'MACHINE' are: amd64, arm64, raspi3b

sudo MACHINE= ./run.sh

# The following updates can be Over the Air.

# First you change the components to be included in the gokrazy build

# by modifiying the array list in the top section of build.sh and then,

# setting OUTPUT=ota will automatically

# perform an over-the-network (via http/https) update to a running gokrazy instance.

# The address for the ota can be tweaked by setting the SHOULDUPDATE_CONTENT env var.

GOARCH= GOOS=linux OUTPUT=ota SHOULDUPDATE_CONTENT="http://gokrazy:$(cat $HOME/.config/gokrazy/http-password.txt)@/" ./build.sh

# or for macOS/darwin

GOARCH= GOOS=darwin OUTPUT=ota SHOULDUPDATE_CONTENT="http://gokrazy:$(cat $HOME/Library/Application\ Support/gokrazy/http-password.txt)@/" ./build.sh

# NOTE: if (and only if) you are using Vagrant as the base of your setup

# use this value

# SHOULDUPDATE_CONTENT:="http://gokrazy:$(cat $HOME/.config/gokrazy/http-password.txt)@127.0.0.1:8080/"

# which takes into account for the local ip and the port forwarding happening on that setup.

# alternatively

# Setting OUTPUT=single allows to force a rebuild of the img file

# (you will then need to ./run.sh again to load it afresh).

GOARCH= GOOS= OUTPUT=single ./build.sh

# alternatively

# setting OUTPUT=multi will output 3 separate files for:

# boot: boot.img

# root: root.squashfs

# mbr: mbr.img

# This is useful for special purposes when you need

# separated files for each partition.

GOARCH= GOOS= OUTPUT=multi ./build.sh

```