diff --git a/website/docs/CNAME b/website/docs/CNAME deleted file mode 100644 index eacc754..0000000 --- a/website/docs/CNAME +++ /dev/null @@ -1 +0,0 @@ -gokrazy.org diff --git a/website/docs/favicon.ico b/website/docs/favicon.ico deleted file mode 100644 index 32c597c..0000000 Binary files a/website/docs/favicon.ico and /dev/null differ diff --git a/website/docs/index.html b/website/docs/index.html deleted file mode 100644 index d28822b..0000000 --- a/website/docs/index.html +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - -gokrazy - a pure-Go userland for your Raspberry Pi 3 appliances - - - - - - - -
-

gokrazy

-
- - - -
- -

gokrazy is a pure-Go userland for your Raspberry Pi 3 appliances

-

- For a long time, we were unhappy with having to care about security - issues and Linux distribution maintenance on our various Raspberry Pis. -

-

- Then, we had a crazy idea: what if we got rid of memory-unsafe - languages and all software we don’t strictly need? -

-

- Turns out this is feasible. gokrazy is the result. -

-
- -
-
-

Your app(s) + only 4 moving parts

-
    -
  1. the Linux kernel
    2. -
  2. the Raspberry Pi firmware files
    3. -
  3. the Go compiler and standard library
    4. -
  4. the gokrazy userland
    5. -
-

- All are updated using the same command. -

- -

Web status interface

-

- On a regular Linux distribution, we’d largely use systemctl’s start, - stop, restart and status verbs to manage our applications. gokrazy - comes with a convenient web interface for - seeing process status and stopping/restarting processes. -

- -

Debugging

-

- Sometimes, an interactive busybox session or a quick - tcpdump run are invaluable. breakglass allows - you to temporarily enable SSH/SCP-based authenticated remote code - execution: scp your statically compiled binary, then run it - interactively via ssh. -

-
- -
-

Constraints

-

- Due to no C runtime environment being present, your code must compile - with the environment variable CGO_ENABLED=0. To - cross-compile for the Raspberry Pi 3, use GOARCH=arm64. - If your program still builds, you’re good to go! -

- -

Network updates

-

- After building a new gokrazy image on your computer, you can easily - update an existing gokrazy installation in-place thanks to the A/B - partitioning scheme we use. Just specify the -update - flag when building your new image. -

- -

Minimal state and configuration

-

- A tiny amount of configuration is built into the images (e.g. - hostname, password, serial console behavior). In general, we prefer - auto-configuration (e.g. DHCP) over config files. If you need more - configurability, you may need to replace some of our programs. -

-
-
- - - -
- - - - - diff --git a/website/docs/jumbotron-narrow.css b/website/docs/jumbotron-narrow.css deleted file mode 100644 index fb7c49a..0000000 --- a/website/docs/jumbotron-narrow.css +++ /dev/null @@ -1,79 +0,0 @@ -/* Space out content a bit */ -body { - padding-top: 20px; - padding-bottom: 20px; -} - -/* Everything but the jumbotron gets side spacing for mobile first views */ -.header, -.marketing, -.footer { - padding-right: 15px; - padding-left: 15px; -} - -/* Custom page header */ -.header { - border-bottom: 1px solid #e5e5e5; -} -/* Make the masthead heading the same height as the navigation */ -.header h3 { - padding-bottom: 19px; - margin-top: 0; - margin-bottom: 0; - line-height: 40px; -} - -/* Custom page footer */ -.footer { - padding-top: 19px; - color: #777; - border-top: 1px solid #e5e5e5; -} - -/* Customize container */ -@media (min-width: 768px) { - .container { - max-width: 730px; - } -} -.container-narrow > hr { - margin: 30px 0; -} - -/* Main marketing message and sign up button */ -.jumbotron { - text-align: center; - border-bottom: 1px solid #e5e5e5; -} -.jumbotron .btn { - padding: 14px 24px; - font-size: 21px; -} - -/* Supporting marketing content */ -.marketing { - margin: 40px 0; -} -.marketing p + h4 { - margin-top: 28px; -} - -/* Responsive: Portrait tablets and up */ -@media screen and (min-width: 768px) { - /* Remove the padding we set earlier */ - .header, - .marketing, - .footer { - padding-right: 0; - padding-left: 0; - } - /* Space out the masthead */ - .header { - margin-bottom: 30px; - } - /* Remove the bottom border on the jumbotron for visual effect */ - .jumbotron { - border-bottom: 0; - } -} diff --git a/website/docs/jumbotron-narrow.min.css b/website/docs/jumbotron-narrow.min.css deleted file mode 100644 index 0c5a883..0000000 --- a/website/docs/jumbotron-narrow.min.css +++ /dev/null @@ -1 +0,0 @@ -body{padding-top:20px;padding-bottom:20px}.header,.marketing,.footer{padding-right:15px;padding-left:15px}.header{border-bottom:1px solid #e5e5e5}.header h3{padding-bottom:19px;margin-top:0;margin-bottom:0;line-height:40px}.footer{padding-top:19px;color:#777;border-top:1px solid #e5e5e5}@media(min-width:768px){.container{max-width:730px}}.container-narrow>hr{margin:30px 0}.jumbotron{text-align:center;border-bottom:1px solid #e5e5e5}.jumbotron .btn{padding:14px 24px;font-size:21px}.marketing{margin:40px 0}.marketing p+h4{margin-top:28px}@media screen and (min-width:768px){.header,.marketing,.footer{padding-right:0;padding-left:0}.header{margin-bottom:30px}.jumbotron{border-bottom:0}} \ No newline at end of file diff --git a/website/docs/logo.png b/website/docs/logo.png deleted file mode 100644 index 05b5286..0000000 Binary files a/website/docs/logo.png and /dev/null differ diff --git a/website/docs/logo.svg b/website/docs/logo.svg deleted file mode 100644 index 927ce51..0000000 --- a/website/docs/logo.svg +++ /dev/null @@ -1,663 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/website/docs/modules/index.html b/website/docs/modules/index.html deleted file mode 100644 index 42e7aa1..0000000 --- a/website/docs/modules/index.html +++ /dev/null @@ -1,80 +0,0 @@ - - - - - -using Go modules - - - - - - - -
-

gokrazy

-
- - -
-
-

Using Go modules

- -

pull in repositories from your GOPATH

-

- By default, Go modules will not look at $GOPATH/src, - i.e. all packages passed to gokr-packer will be downloaded. If you - had unpublished changes or packages in your $GOPATH, - you can use the following steps to declare a Go module and pull it - into the build: -

- 
IMPORTPATH=github.com/stapelberg/gibot-i3
-(cd $(go env GOPATH)/src/${IMPORTPATH?} && GO111MODULE=on go mod init ${IMPORTPATH?})
-go mod edit -require ${IMPORTPATH?}@v0.0.0
-go mod edit -replace ${IMPORTPATH?}=$(go env GOPATH)/src/${IMPORTPATH?}
-
- -

pull in local repositories

-

- Please see https://github.com/golang/go/wiki/Modules#when-should-i-use-the-replace-directive. -

- -
-
- - -
- - - - - diff --git a/website/docs/overview.png b/website/docs/overview.png deleted file mode 100644 index 6e6f2bc..0000000 Binary files a/website/docs/overview.png and /dev/null differ diff --git a/website/docs/platforms.html b/website/docs/platforms.html deleted file mode 100644 index f057b1d..0000000 --- a/website/docs/platforms.html +++ /dev/null @@ -1 +0,0 @@ -https://gokrazy.org/platforms/ \ No newline at end of file diff --git a/website/docs/platforms/index.html b/website/docs/platforms/index.html deleted file mode 100644 index a90f102..0000000 --- a/website/docs/platforms/index.html +++ /dev/null @@ -1,135 +0,0 @@ - - - - - -gokrazy platforms - - - - - - - -
-

gokrazy

-
- - -
-
-

Supported platforms

-

- bold appliances are tested in the CI setup on real - hardware and gate new kernel and firmware versions, and hence can be - considered supported. -

- -

- Regular appliances are supported in a best-effort way, i.e. they - might be temporarily broken at HEAD. -

- -

- The leading github.com in front of package import paths has been omitted for space reasons. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TargetHardwareGOARCHKernel packageFirmware packageAppliances
apu2c4apu2c4amd64rtr7/kernelrtr7/kernel - gokrazy/bakery/cmd/bake
- rtr7/router7 -
x86-64qemuamd64rtr7/kernelrtr7/kernelgokrazy/bakery/cmd/bake
rpi3braspi3barm64gokrazy/kernelgokrazy/firmware - gokrazy/bakery/cmd/bake
- stapelberg/avr-x1100w
- stapelberg/dornröschen
- stapelberg/hmgo
- stapelberg/scan2drive -
rpi3b+raspi3b+arm64gokrazy/kernelgokrazy/firmwaregokrazy/bakery/cmd/bake
- -
-
- - -
- - - - - diff --git a/website/docs/prototyping.html b/website/docs/prototyping.html deleted file mode 100644 index 68aa245..0000000 --- a/website/docs/prototyping.html +++ /dev/null @@ -1 +0,0 @@ -https://gokrazy.org/prototyping/ \ No newline at end of file diff --git a/website/docs/prototyping/index.html b/website/docs/prototyping/index.html deleted file mode 100644 index 7268b60..0000000 --- a/website/docs/prototyping/index.html +++ /dev/null @@ -1,256 +0,0 @@ - - - - - -gokrazy prototyping - - - - - - - -
-

gokrazy

-
- - -
-
-

Prototyping

-

- To realize the full benefits of gokrazy, you need to use only - software written in Go. If there is no Go software for what you want - to do, creating that piece of software can pose a seemingly - unsurmountable hurdle. To make some quick progress and figure out if - your idea can be implemented, it might make sense to temporarily use - existing software before starting your own implementation. -

- -

- This article shows a couple of techniques for getting non-Go - software to work on gokrazy, in increasing order of complexity. -

- -

- Note that software which is manually installed like shown - here will not be automatically updated by gokrazy - and hence poses a security risk. Use these techniques only for - prototyping. -

- -

Go software not written for gokrazy: node-exporter

-

- The Prometheus node-exporter doesn’t use cgo and needs no - command-line parameters, configuration files or other assets can be - added to the gokr-packer command line. -

- -

Go software not written for gokrazy: Grafana

-

- It would not suffice to add Grafana to your gokr-packer - command, as the resulting Grafana binary requires assets, supports - plugins, keeps state, etc. -

- -

- Hence, you need to manually install Grafana into a directory - underneath /perm. A convenient way to do that is to - use breakglass - to download the “Standalone Linux Binaries” release from - https://grafana.com/grafana/download?platform=arm. Note - that I am serving the file from my computer because my busybox - version supports neither HTTPS nor DNS. -

- - 
-/tmp/breakglass531810560 # wget http://10.0.0.76:4080/grafana-5.3.2.linux-arm64.tar.gz
-/tmp/breakglass531810560 # tar xf grafana-5.3.2.linux-arm64.tar.gz
- -

- We cannot start Grafana yet, as its binary is dynamically - linked. One way to fix this is to place the sources which correspond - to the release you just unpacked (e.g. from - https://github.com/grafana/grafana/tree/v5.3.2) - in your $GOPATH and recompile the binaries: -

- - 
GOARCH=arm64 CGO_ENABLED=1 CC=aarch64-linux-gnu-gcc go install \
-	    -ldflags "-linkmode external -extldflags -static" \
-	    github.com/grafana/grafana/pkg/cmd/...
- -

- Note that it is usually easier to set the environment - variable CGO_ENABLED=0 to get a statically linked - binary, but Grafana uses sqlite3, which is written in C, so we - resort to the -ldflags variant. -

- -

- At this point, we can start Grafana from breakglass: -

- - 
-/tmp/breakglass531810560 # cd grafana-5.3.2
-/tmp/breakglass531810560/grafana-5.3.2 # wget http://10.0.0.76:4080/grafana-server
-/tmp/breakglass531810560/grafana-5.3.2 # install -m 755 grafana-server bin/ && rm grafana-server
-/tmp/breakglass531810560/grafana-5.3.2 # ./bin/grafana-server
-INFO[10-30|19:27:51] Starting Grafana                         logger=server version=5.0.0 commit=NA compiled=2018-10-30T19:27:51+0100
-…
- - -

- To have gokrazy start Grafana, we can use a Go package like this: -

- - 
-package main
-
-import (
-  "log"
-  "syscall"
-)
-
-func main() {
-  const bin = "/perm/grafana/bin/grafana-server"
-  if err := syscall.Exec(bin, []string{bin, "-homepath=/perm/grafana"}, nil); err != nil {
-    log.Fatal(err)
-  }
-}
-
- -

C software: WireGuard

- -

- WireGuard is a modern VPN tunnel, which consists of a Linux kernel - module and a configuration - tool. See rtr7/kernel@c7afbc1f - for how the kernel module was added to the router7 kernel. -

- -

- The configuration tool can be statically cross-compiled. We can run - Debian in a Docker container to not mess with our host system: -

- - 
-% mkdir /tmp/wg
-% cd /tmp/wg
-% docker run -t -i debian
-root@d1728eaaa6e1:/# dpkg --add-architecture arm64
-root@d1728eaaa6e1:/# apt update
-root@d1728eaaa6e1:/# apt install libmnl-dev:arm64 libelf-dev:arm64 linux-headers-amd64 crossbuild-essential-arm64 pkg-config wget
-root@d1728eaaa6e1:/# wget https://git.zx2c4.com/WireGuard/snapshot/WireGuard-0.0.20181018.tar.xz
-root@d1728eaaa6e1:/# tar xf WireGuard-0.0.20181018.tar.xz
-root@d1728eaaa6e1:/# cd WireGuard-0.0.20181018/src/tools
-root@d1728eaaa6e1:/# make CC=aarch64-linux-gnu-gcc LDFLAGS=-static
-root@d1728eaaa6e1:/# exit
-% docker cp -L d1728eaaa6e1:/WireGuard-0.0.20181018/src/tools/wg .
- -

- Now we can copy and run the wg binary via breakglass: -

- - 
-/tmp/breakglass531810560 # wget http://10.0.0.76:4080/wg
-/tmp/breakglass531810560 # chmod +x wg
-/tmp/breakglass531810560 # ./wg --help
-Usage: ./wg <cmd> [<args>]
-…
- -

C software: tc

-

- Linux’s Traffic Control system (used e.g. for traffic shaping) is - configured with the tc tool. -

- -

- tc is a special case in that it requires to be - dynamically linked. The different queueing disciplines are - implemented as plugins, and statically linking tc - results in a binary which starts but won’t be able to display or - change queueing disciplines. -

- -

- Because gokrazy doesn’t include a C runtime environment, we’ll need - to copy not only the tc binary, but also the dynamic - loader and all required shared libraries. We can run Debian in a - Docker container to not mess with our host system: -

- - 
-% mkdir /tmp/iproute
-% cd /tmp/iproute
-% docker run -t -i debian
-root@6e530a973d45:/# dpkg --add-architecture arm64
-root@6e530a973d45:/# apt update
-root@6e530a973d45:/# apt install iproute2:arm64 qemu-user-static
-root@6e530a973d45:/# LD_TRACE_LOADED_OBJECTS=1 qemu-aarch64-static /sbin/tc
-	libelf.so.1 => /usr/lib/aarch64-linux-gnu/libelf.so.1 (0x00000040008a6000)
-	libm.so.6 => /lib/aarch64-linux-gnu/libm.so.6 (0x00000040008cb000)
-	libdl.so.2 => /lib/aarch64-linux-gnu/libdl.so.2 (0x0000004000976000)
-	libc.so.6 => /lib/aarch64-linux-gnu/libc.so.6 (0x0000004000989000)
-	/lib/ld-linux-aarch64.so.1 (0x0000004000870000)
-	libz.so.1 => /lib/aarch64-linux-gnu/libz.so.1 (0x0000004000ad3000)
-root@6e530a973d45:/# exit
-% docker cp -L 6e530a973d45:/sbin/tc .
-% docker cp -L 6e530a973d45:/lib/ld-linux-aarch64.so.1 .
-% docker cp -L 6e530a973d45:/usr/lib/aarch64-linux-gnu/libelf.so.1 .
-% docker cp -L 6e530a973d45:/lib/aarch64-linux-gnu/libm.so.6 .
-% docker cp -L 6e530a973d45:/lib/aarch64-linux-gnu/libdl.so.2 .
-% docker cp -L 6e530a973d45:/lib/aarch64-linux-gnu/libc.so.6 .
-% docker cp -L 6e530a973d45:/lib/aarch64-linux-gnu/libz.so.1 .
- -

- Now we can copy the contents of the temporary directory to - e.g. /perm/tc and run the tc command in - breakglass: -

- - 
-/tmp/breakglass531810560 # wget -O- http://10.0.0.76:4080/tc.tar | tar xf -
-/tmp/breakglass531810560 # LD_LIBRARY_PATH=$PWD ./ld-linux-aarch64.so.1 ./tc
-Usage: tc [ OPTIONS ] OBJECT { COMMAND | help }
-…
- -
-
- - -
- - - - - diff --git a/website/docs/quickstart.html b/website/docs/quickstart.html deleted file mode 100644 index 8ef6dd4..0000000 --- a/website/docs/quickstart.html +++ /dev/null @@ -1 +0,0 @@ -https://gokrazy.org/quickstart/ \ No newline at end of file diff --git a/website/docs/quickstart/index.html b/website/docs/quickstart/index.html deleted file mode 100644 index 35ae262..0000000 --- a/website/docs/quickstart/index.html +++ /dev/null @@ -1,119 +0,0 @@ - - - - - -gokrazy quickstart - - - - - - - -
-

gokrazy

-
- - -
-
-

Get a Raspberry Pi 3 (no other model)

-

- Currently, the Raspberry Pi 3 is the only - model supported. Many people assume the Raspberry Pi Zero W - could be used as well. Unfortunately, it uses the older - BCM2835 SoC, which is not arm64, so gokrazy won’t run on - it. See - also stapelberg’s - reddit comment about supported hardware. -

- -

Install Go

-

- If you don’t already have Go installed, install the latest Go version. -

- -

Install the gokrazy packer

- 
INSTANCE=gokrazy/hello; mkdir -p ~/${INSTANCE?} && cd ~/${INSTANCE?} && echo module ${INSTANCE?} > go.mod
-go get -u github.com/gokrazy/tools/cmd/gokr-packer
- -

Overwrite an SD card with gokrazy

-

- Plug an SD card into your card reader and locate its device node by checking dmesg | tail. In this example, we’ll assume the SD card is accessible as /dev/sdb. -

-

- To overwrite the entire SD card /dev/sdb with a gokrazy installation running a hello world program, use: -

- 
cd ~/gokrazy/hello
-gokr-packer -overwrite=/dev/sdb github.com/gokrazy/hello github.com/gokrazy/serial-busybox
-

- The gokr-packer command above will result in log output like this: -

- 
2017/03/01 20:59:55 packer.go:85: installing [github.com/gokrazy/hello]
-2017/03/01 20:59:56 packer.go:131: partitioning /dev/sdb
-2017/03/01 20:59:56 parttable.go:40: device holds 15931539456 bytes
-2017/03/01 20:59:56 packer.go:139: waiting for /dev/sdb1 to appear
-If your applications need to store persistent data, create a file system using e.g.:
-
-	mkfs.ext4 /dev/sdb4
-
-To boot gokrazy, plug the SD card into a Raspberry Pi 3 (no other model supported)
-
-To interact with the device, gokrazy provides a web interface reachable at:
-
-	http://gokrazy:<automatically-generated-random-password>@gokrazy/
-
-There will be not be any other output (no HDMI, no serial console, etc.)
-

- After booting from this SD card, your Raspberry Pi 3 will: -

    -
  • obtain an IP address for hostname “gokrazy” via DHCP (IPv4) and SLAAC (IPv6)
    • -
  • synchronize the clock using NTP
    • -
  • expose a password-authenticated web interface on private IP addresses
    - (the default password can be recovered from ~/.config/gokrazy/http-password.txt)
    • -
  • supervise all installed programs (only the hello world program in this example)
    • -
- The only way for you to interact with the device is via the - web interface (unless the installed programs provide other - ways). There will be no HDMI output, no serial console, etc. -

-
-
- - -
- - - - - diff --git a/website/docs/robots.txt b/website/docs/robots.txt deleted file mode 100644 index 4f9540b..0000000 --- a/website/docs/robots.txt +++ /dev/null @@ -1 +0,0 @@ -User-agent: * \ No newline at end of file diff --git a/website/docs/showcase.html b/website/docs/showcase.html deleted file mode 100644 index efde410..0000000 --- a/website/docs/showcase.html +++ /dev/null @@ -1 +0,0 @@ -https://gokrazy.org/showcase/ \ No newline at end of file diff --git a/website/docs/showcase/index.html b/website/docs/showcase/index.html deleted file mode 100644 index b082ed5..0000000 --- a/website/docs/showcase/index.html +++ /dev/null @@ -1,139 +0,0 @@ - - - - - -gokrazy showcase - - - - - - - -
-

gokrazy

-
- - -
-
-

Showcase

-

Written for gokrazy

-

-The following third-party programs specifically target gokrazy: -

-
    -
  • - router7
    - Pure-Go small home internet router -
    • -
  • -avr-x1100w
    -Automatically switches input sources on a Denon AVR-X1100W A/V receiver -depending on which media source is in use (specific to stapelberg’s home network). -
    • -
  • -dornröschen
    -SSH-based backup and storage sync orchestration (specific to stapelberg’s home network). -
    • -
  • -hmgo
    -Minimal HomeMatic house automation central control unit replacement (specific -to stapelberg’s home network). -
    • -
  • -scan2drive
    -scan2drive is a Raspberry Pi 3-based appliance (with a web interface) -for scanning, converting and uploading physical documents to Google -Drive. -
    • -
  • -beatbox
    -beatbox is a Raspberry Pi 3-based toy that combines a Mir:ror and NFC -figurines for playing music stored on the device or directly from Spotify. -
    • -
- -

-To get your program listed here, just send us a pull request. -

- -

Successfully tested

-

-The following third-party programs have been successfully used with gokrazy -but might require additional setup: -

-
    -
  • - Prometheus
    - Monitoring system & time series database -
    • - -
  • - Prometheus - node exporter
    Exposes various metrics of the system on - which it is running for use with the - prometheus monitoring and alerting system. -
    • - -
  • - Prometheus - blackbox exporter
    allows blackbox probing of endpoints over - HTTP, HTTPS, DNS, TCP and ICMP for use with the - prometheus monitoring and alerting system. -
    • - -
  • - Grafana
    - The open platform for beautiful analytics and monitoring -
    • -
- -

No Go software for your idea?

-

- You can prototype your idea by temporarily using existing software to close - the gap. See Prototyping. -

-
-
- - -
- - - - - diff --git a/website/docs/sitemap.xml b/website/docs/sitemap.xml deleted file mode 100644 index ea67749..0000000 --- a/website/docs/sitemap.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - https://gokrazy.org/ - - - - https://gokrazy.org/platforms/ - - - - https://gokrazy.org/prototyping/ - - - - https://gokrazy.org/quickstart/ - - - - https://gokrazy.org/showcase/ - - - - https://gokrazy.org/modules/ - - - \ No newline at end of file