diff --git a/docs/index.html b/docs/index.html index d28822b..3b84f75 100644 --- a/docs/index.html +++ b/docs/index.html @@ -36,6 +36,9 @@ body {
  • Showcase
    • +
  • Userguide
    • + +
  • Source
    • diff --git a/docs/modules/index.html b/docs/modules/index.html index 42e7aa1..d5f8f0c 100644 --- a/docs/modules/index.html +++ b/docs/modules/index.html @@ -35,6 +35,9 @@ body {
  • Showcase
    • +
  • Userguide
    • + +
  • Source
    • diff --git a/docs/platforms/index.html b/docs/platforms/index.html index a90f102..e461573 100644 --- a/docs/platforms/index.html +++ b/docs/platforms/index.html @@ -35,6 +35,9 @@ body {
  • Showcase
    • +
  • Userguide
    • + +
  • Source
    • diff --git a/docs/prototyping/index.html b/docs/prototyping/index.html index 7268b60..317e8ed 100644 --- a/docs/prototyping/index.html +++ b/docs/prototyping/index.html @@ -35,6 +35,9 @@ body {
  • Showcase
    • +
  • Userguide
    • + +
  • Source
    • diff --git a/docs/quickstart/index.html b/docs/quickstart/index.html index 35ae262..9c6f9c4 100644 --- a/docs/quickstart/index.html +++ b/docs/quickstart/index.html @@ -35,6 +35,9 @@ body {
  • Showcase
    • +
  • Userguide
    • + +
  • Source
    • diff --git a/docs/showcase/index.html b/docs/showcase/index.html index b082ed5..cf09795 100644 --- a/docs/showcase/index.html +++ b/docs/showcase/index.html @@ -35,6 +35,9 @@ body { +
  • Userguide
    • + +
  • Source
    • diff --git a/docs/sitemap.xml b/docs/sitemap.xml index ea67749..cff922f 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -22,8 +22,16 @@ https://gokrazy.org/showcase/ + + https://gokrazy.org/userguide/ + + https://gokrazy.org/modules/ + + https://gokrazy.org/userguide/remotesyslog/ + + \ No newline at end of file diff --git a/docs/userguide/index.html b/docs/userguide/index.html new file mode 100644 index 0000000..ec3fc20 --- /dev/null +++ b/docs/userguide/index.html @@ -0,0 +1,70 @@ + + + + + +gokrazy Userguide + + + + + + + +
    +

    gokrazy

    +
    + + +

    gokrazy Userguide

    +

    The gokrazy Userguide walks you through various topics.

    +

    Userguide contents

    + + + + + +
    + + + + + diff --git a/docs/userguide/remotesyslog/index.html b/docs/userguide/remotesyslog/index.html new file mode 100644 index 0000000..409b1d9 --- /dev/null +++ b/docs/userguide/remotesyslog/index.html @@ -0,0 +1,81 @@ + + + + + +Using Remote Syslog to send gokrazy logs over the network + + + + + + + +
    +

    gokrazy

    +
    + +

    Using Remote Syslog to send gokrazy logs over the network

    +

    If you update your gokrazy installations daily, as we recommend you do, logs +will be cleared daily as a side effect of rebooting the device. You can use +Remote Syslog to +persist logs elsewhere for later analysis.

    +

    Client side (gokrazy)

    +

    To enable remote syslog, you need to configure a target by creating the file +remote_syslog/target on the permanent data partition.

    +
    # The following assumes you already created a file system
+# on the permanent data partition. Otherwise, please use:
+# sudo mkfs.ext4 /dev/disk/by-partuuid/2e18c40c-04
+
+sudo mount /dev/disk/by-partuuid/2e18c40c-04 /mnt
+echo 10.0.0.76:514 | sudo tee /mnt/remote_syslog/target
+sudo umount /mnt
+

    I recommend using a (static) IP address for increased reliability, so that +remote syslog works even when DNS does not.

    +

    Server side (syslog-ng)

    +

    This is how I instruct syslog-ng via +its /etc/syslog-ng/syslog-ng.conf to write syslog messages it received from +e.g. host gokrazy to /var/log/remote/gokrazy-log:

    +
    source net { network(ip(10.0.0.76) transport("udp")); };
+destination remote { file("/var/log/remote/${FULLHOST}-log"); };
+log { source(net); destination(remote); };
+
    + +
    + + + + + diff --git a/website/content/userguide/_index.md b/website/content/userguide/_index.md new file mode 100644 index 0000000..71f95b8 --- /dev/null +++ b/website/content/userguide/_index.md @@ -0,0 +1,13 @@ +--- +title: "gokrazy Userguide" +menu: + main: + title: "Userguide" + weight: 55 +--- + +# gokrazy Userguide + +The gokrazy Userguide walks you through various topics. + +## Userguide contents diff --git a/website/content/userguide/remotesyslog.md b/website/content/userguide/remotesyslog.md new file mode 100644 index 0000000..bc17565 --- /dev/null +++ b/website/content/userguide/remotesyslog.md @@ -0,0 +1,40 @@ +--- +title: "Using Remote Syslog to send gokrazy logs over the network" +--- + +# Using Remote Syslog to send gokrazy logs over the network + +If you update your gokrazy installations daily, as we recommend you do, logs +will be cleared daily as a side effect of rebooting the device. You can use +[Remote Syslog](https://en.wikipedia.org/wiki/Syslog#Network_protocol) to +persist logs elsewhere for later analysis. + +## Client side (gokrazy) + +To enable remote syslog, you need to configure a target by creating the file +`remote_syslog/target` on the permanent data partition. + +```shell +# The following assumes you already created a file system +# on the permanent data partition. Otherwise, please use: +# sudo mkfs.ext4 /dev/disk/by-partuuid/2e18c40c-04 + +sudo mount /dev/disk/by-partuuid/2e18c40c-04 /mnt +echo 10.0.0.76:514 | sudo tee /mnt/remote_syslog/target +sudo umount /mnt +``` + +I recommend using a (static) IP address for increased reliability, so that +remote syslog works even when DNS does not. + +## Server side (syslog-ng) + +This is how I instruct [syslog-ng](https://en.wikipedia.org/wiki/Syslog-ng) via +its `/etc/syslog-ng/syslog-ng.conf` to write syslog messages it received from +e.g. host `gokrazy` to `/var/log/remote/gokrazy-log`: + +``` +source net { network(ip(10.0.0.76) transport("udp")); }; +destination remote { file("/var/log/remote/${FULLHOST}-log"); }; +log { source(net); destination(remote); }; +``` diff --git a/website/themes/gokrazy/layouts/_default/list.html b/website/themes/gokrazy/layouts/_default/list.html index 7d558b2..f446965 100644 --- a/website/themes/gokrazy/layouts/_default/list.html +++ b/website/themes/gokrazy/layouts/_default/list.html @@ -1,10 +1,4 @@ {{ define "main" }} -
    -
    - - {{- partial "nav.html" . -}} - -

    list template

    {{ .Content }} @@ -16,17 +10,5 @@ {{ end }} -
    - -

    - © 2017 gokrazy authors (Michael Stapelberg and contributors) -

    -
    -
    - -
    -
    {{ end }}