Added CI workflow and fixed README markdown

Author: EvanK

.github/workflows/ci.yaml

@@ -0,0 +1,52 @@
+name: Build and test apache module
+
+on:
+  # Triggers on push/pull only for the "master" branch
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+  # Allows running workflow manually
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install packages we'll need for building
+        run: |
+          sudo apt-get update
+          sudo apt-get -y install build-essential libtool \
+            apache2 apache2-dev apache2-utils \
+            libapr1-dev libaprutil1-dev \
+            curl fortune
+        # git clone https://github.com/EvanK/apache2-mod-fortune.git ~/a2mf && cd ~/a2mf && apxs -c mod_fortune.c && apxs -i -a mod_fortune.la
+      - name: Build and install module
+        run: |
+          apxs -c mod_fortune.c
+          sudo apxs -i -a mod_fortune.la
+      - name: Ensure module combiled to shared object
+        run: ls -1  /usr/lib/apache2/modules/mod_fortune.so
+      - name: Ensure module installed and enabled
+        run: ls -1 /etc/apache2/mods-enabled/fortune.load
+        # ^^ need to figure correct so and conf paths here and below
+      - name: Add to apache config
+        run: |
+          cat << EOF | sudo tee -a /etc/apache2/apache2.conf
+          <IfModule headers_module>
+            <IfModule fortune_module>
+                FortuneMaxLength 1000
+            </IfModule>
+            Header onsuccess set X-Fortune %{FORTUNE_COOKIE}e env=FORTUNE_COOKIE
+          </IfModule>
+          EOF
+      - name: Enable headers module as we'll need it
+        run: sudo a2enmod headers
+      - name: Gracefully (re)start apache
+        run: sudo apachectl graceful
+        # run: kill -s USR1 $(cat /usr/local/apache2/logs/httpd.pid)
+        # ^^ hopefully can use systemctl or something to do this
+      - name: Test for fortune header
+        run: curl -sI http://localhost/ | grep X-Fortune

README.md

@@ -1,57 +1,61 @@
-mod_fortune
-===
+# mod_fortune
 
 
-Covering My Behind
---
+## Covering My Behind
+
 This is my first foray into writing Apache2 modules, and it is meant as both a learning exercise for me and an entertaining piece of open source software for the world at large.  It is by no means optimized for high-availability environments and I make no guarantee that it is free of bugs or security flaws.  Use at your own risk!
 
 
-What Is `fortune`?
---
+## What Is `fortune`?
+
 Anyone that's made heavy use of Linux has probably come across the `fortune` program at some point.  It outputs "a random, hopefully interesting, adage" on demand, a sort of digital fortune cookie (hence the name).
 
 
-What is `mod_fortune`?
---
+## What is `mod_fortune`?
+
 It is a module for the Apache2 webserver that pipes the output of the `fortune` command into an environment variable.  This results in each and every request to the webserver having available a different fortune that can be dumped into a header, accessed by a CGI script, or any other number of things.
 
 
-Why?
---
+## Why?
+
 I wrote this mostly for fun and because it's been a while since I dabbled in the C language.
 
 
-How?
---
+## How?
+
 There are multiple ways to compile and install an apache module.  My preferred method is to use `apxs`:
-    # build shared object file
-    apxs -c mod_fortune.c 
-    # and install it (may require root/sudo)
-    apxs -i -a mod_fortune.la
+
+```shell
+# build shared object file
+apxs -c mod_fortune.c 
+# and install it (may require root/sudo)
+apxs -i -a mod_fortune.la
+```
+
 This should not only move the object file into place, but add a *LoadModule* directive into your apache configuration.
 
 
-Licensing
---
-This software is released as open source under the MIT license:
-    http://www.opensource.org/licenses/mit-license.php
+## Licensing
+
+This software is released as open source under [the MIT license](http://www.opensource.org/licenses/mit-license.php)
+
 
+## Usage Example
 
-Usage Example
---
 This is an example configuration that would insert an `X-Fortune` header to every successful request.
-    # if mod_header is enabled...
-    <IfModule mod_header.c>
-        # load and configure mod_fortune (default path but custom max length)
-        LoadModule fortune_module modules/mod_fortune.so
-        
-        <IfModule mod_fortune.c>
-            FortuneMaxLength 1000
-            #FortuneProgram /usr/games/fortune
-        </IfModule>
-        
-        # set X-Fortune header for successful response, if env variable exists
-        Header onsuccess set X-Fortune %{FORTUNE_COOKIE}e env=FORTUNE_COOKIE
-    </IfModule>
 
+```apache
+# if mod_header is enabled...
+<IfModule mod_header.c>
+    # load and configure mod_fortune (default path but custom max length)
+    LoadModule fortune_module modules/mod_fortune.so
+    
+    <IfModule mod_fortune.c>
+        FortuneMaxLength 1000
+        #FortuneProgram /usr/games/fortune
+    </IfModule>
+    
+    # set X-Fortune header for successful response, if env variable exists
+    Header onsuccess set X-Fortune %{FORTUNE_COOKIE}e env=FORTUNE_COOKIE
+</IfModule>
+```