Merge pull request #2 from Ferruck/build-systemd-image

container/lighttpd: Add image build option

Author: jkloetzke

README.md

@@ -27,21 +27,41 @@ example](https://github.com/BobBuildTool/bob-example-embedded).
 
 # How to build
 
-Clone the recipes and build them with Bob:
+First of all you have to clone the recipes and change to the checked-out
+directory:
 
     $ git clone https://github.com/BobBuildTool/bob-example-containers.git \
 	    --recurse-submodules
     $ cd bob-example-containers
+
+The next steps depend on what you want to build.
+
+## Docker Container
+
+These recipes can build a minimal container image that has solely lighttpd and
+the required dependencies installed by running the following command:
+
+    $ # Still in the bob-example-containers directory
     $ bob build containers::lighttpd
 
-These recipes build a minimal container image that has solely lighttpd and the
-required dependencies installed.
+## Systemd Portable Service
+
+These recipes can also provide a systemd portable service that can be attached
+with `portablectl` by issuing the following command:
+
+    $ # Still in the bob-example-containers directory
+    $ bob build containers::lighttpd-image
 
 # How to use
 
+Again, usage of the build products depends on the chosen target.
+
+## Docker Container
+
 To use it you have to import it in Docker:
 
-    $ # Still in the bob-example-containers directory
+    $ # Still in the bob-example-containers directory after building
+    $ # containers::lighttpd
     $ tar -C $(bob query-path -f '{dist}' --release containers::lighttpd) -c . \
         | docker import - lighttpd
 
@@ -53,6 +73,20 @@ Now you can serve any host directory with the lighttpd in the image:
 
 This will expose the lighttpd at port 8080 on your host.
 
+## Systemd Portable Service
+
+First you have to import the portable service:
+
+    $ # Still in the bob-example-containers directory after building
+    $ # containers::lighttpd-image
+    $ portablectl attach $(bob query-path -f '{dist}' --release containers::lighttpd-image)/lighttpd.raw
+
+Now you can start the lighttpd as any other systemd service on your host:
+
+    $ systemctl start lighttpd.service
+
+lighttpd should now listen on port 80.
+
 # Contributions
 
 Contributions are welcome in form of feedback, bug reports and code. If you want

config.yaml

@@ -1,3 +1,3 @@
-bobMinimumVersion: "0.15"
+bobMinimumVersion: "0.16rc1"
 layers:
     - basement

layers/basement

@@ -39,5 +39,44 @@ buildScript: |
     lighttpd:x:33:
     EOF
 
-packageScript: |
-    cp -a $1/* .
+    # Default landing page
+    mkdir -p srv/www
+    install -m 644 $<<lighttpd/index.html>> srv/www/index.html
+
+multiPackage:
+    "":
+        buildScript: |
+            # PID file
+            mkdir -p run/lighttpd
+            touch run/lighttpd/lighttpd.pid
+
+        packageScript: |
+            cp -a $1/* .
+
+    image:
+        buildTools: [squashfs-tools]
+        buildScript: |
+            # Remove username and group because the systemd.service already
+            # takes care of this.
+            sed -i -e '/server.username/d' -e '/server.groupname/d' \
+                etc/lighttpd/lighttpd.conf
+
+            # See https://systemd.io/PORTABLE_SERVICES.html
+            mkdir -p etc/systemd/system
+            install -m 644 $<<lighttpd/lighttpd.service>> \
+                            etc/systemd/system/lighttpd.service
+            install -m 644 $<<lighttpd/lighttpd.socket>> \
+                            etc/systemd/system/lighttpd.socket
+            touch etc/machine-id
+            ln -s ../usr/lib/os-release etc/os-release
+            touch etc/resolv.conf
+            mkdir -p proc sys dev run tmp usr/lib var/tmp
+            cat >usr/lib/os-release <<EOF
+            NAME="lighttpd"
+            PRETTY_NAME="Bob lighttpd container example"
+            ID=linux
+            HOME_URL="https://github.com/BobBuildTool/bob-example-containers"
+            EOF
+
+        packageScript: |
+            mksquashfs $1 lighttpd.raw

recipes/containers/lighttpd.yaml

@@ -0,0 +1,27 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <title>lighttpd works</title>
+    </head>
+    <body>
+        <h1>It works!</h1>
+        Looks like the lighttpd service is working.
+        <h2>Configuration needed</h2>
+        <h3>Systemd portable service</h3>
+        In order to serve something useful with the portable lighttpd service
+        you must bind the document root directory to <code>/srv/www</code>. This
+        done by adding a drop-in with a <code>BindReadOnlyPaths=</code>, e.g.:
+        <pre>
+# systemctl edit lighttpd.service
+[Service]
+BindReadOnlyPaths=&lt;your-html-dir&gt;:/srv/www
+        </pre>
+        Then restart the service and you should see your documents.
+        <h3>Docker container</h3>
+        When running the docker container you should add the proper
+        <code>-v</code> option to the command line, e.g.:
+        <pre>
+$ docker run -v &lt;your-html-dir&gt;:/srv/www lighttpd ...
+        </pre>
+    </body>
+</html>

recipes/containers/lighttpd/index.html

@@ -2,7 +2,7 @@
 
 var.log_root    = "/var/log/lighttpd"
 var.server_root = "/srv/www"
-var.state_dir   = "/var/run"
+var.state_dir   = "/run/lighttpd"
 var.home_dir    = "/var/lib/lighttpd"
 var.conf_dir    = "/etc/lighttpd"
 
@@ -14,6 +14,7 @@ server.username  = "lighttpd"
 server.groupname = "lighttpd"
 server.document-root = server_root
 server.pid-file = state_dir + "/lighttpd.pid"
+server.systemd-socket-activation = "enable"
 
 server.errorlog             = log_root + "/error.log"
 

recipes/containers/lighttpd/lighttpd.conf

@@ -0,0 +1,20 @@
+[Unit]
+Description=A secure, fast, compliant and very flexible web-server
+After=syslog.target network.target lighttpd.socket
+Requires=lighttpd.socket
+
+
+[Service]
+Type=simple
+PIDFile=/run/lighttpd/lighttpd.pid
+ExecStartPre=/usr/sbin/lighttpd -tt -f /etc/lighttpd/lighttpd.conf
+ExecStart=/usr/sbin/lighttpd -D -f /etc/lighttpd/lighttpd.conf
+ExecReload=/bin/kill -USR1 $MAINPID
+Restart=on-failure
+
+User=lighttpd
+Group=lighttpd
+DynamicUser=yes
+
+RuntimeDirectory=lighttpd
+LogsDirectory=lighttpd

recipes/containers/lighttpd/lighttpd.service

@@ -0,0 +1,8 @@
+[Unit]
+Description=lighttpd socket
+
+[Socket]
+ListenStream=80
+
+[Install]
+WantedBy=sockets.target