gokrazy / syslogd

gokrazy remote syslog server daemon: writes to disk what it receives via remote syslog

Overview

With gokrazy, you can deploy your Go programs as appliances to a Raspberry Pi or PC (→ supported platforms).

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.

→ Learn more at gokrazy.org

GitHub Repository structure

• github.com/gokrazy/gokrazy: system code, main issue tracker, documentation
• github.com/gokrazy/tools: SD card image creation code, pulling in:
  • github.com/gokrazy/firmware: Raspberry Pi 3 or 4 firmware files
  • github.com/gokrazy/rpi-eeprom: Raspberry Pi 4 EEPROM files
  • github.com/gokrazy/kernel: pre-built kernel image and bootloader config

Documentation

gokrazy.org uses hugo for creating and generating the website. You can find the hugo install instructions here: Install Hugo. With hugo you can write documentation in Markdown and generate a static website from it.

The website subdirectory is hugo’s root directory. In order to preview the documentation or to re-generate the website, switch the directory to website.

To preview the website, run the hugo webserver:

hugo serve

Generate the website:

hugo

The updated website content will be stored in the ./docs directory. Do not update anything here manually.

syslogd's Issues

gokr-syslogweb: implement /tail endpoint

Currently, gokr-syslogweb offers a /grep endpoint, but /tail would also be useful.

We can then also publish the slog tool as a CLI frontend to use gokr-syslogweb, and add a slog variant to the README for each example.