From b13a2e76f34b09881067c16a36f4ddbd1f61a7e1 Mon Sep 17 00:00:00 2001
From: Wojtek Kosior <koszko@koszko.org>
Date: Mon, 21 Nov 2022 20:25:17 +0100
Subject: briefly document container use and installation in `Makefile`

---
 README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 5db8552..fff53d9 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,57 @@
 This is Guix system (container) configuration used for the system serving
 https://koszko.org
 
+# Use & installation
+
+The command
+
+```shell
+make && sudo make start-container
+```
+
+causes the container to be run in a test enviroment, with some host directories
+(e.g. `/var/www/koszko.org/html`) faked to contain sample files.
+The command
+
+```shell
+make fake-client
+```
+
+spawns a shell in which `koszko.org` and some other domains resolve to the IP
+address under which the container services are visible to the host.
+The command
+
+```shell
+make enter-container
+```
+
+spawns a shell inside the previously-started container. Finally,
+
+```shell
+sudo make install
+```
+
+registers the container startup script as a Guix gc root and creates an
+`/etc/init.d` SysV-style init script for starting it.
+The container can then be started by systemd with
+
+```shell
+sudo systemctl daemon-reload # only needed once after installation
+sudo systemctl start guix-container
+```
+
+or by the good old SysV init with
+
+```shell
+suso service guix-container start
+```
+
+You can of course also use other systemd or SysV init commands to manage the
+container service.
+
+Feel free to look into the `Makefile` to see what other helpful targets are
+available.
+
 ## Copying
 
 Contents of this repository are Copyright (C) 2022 Wojtek Kosior.
-- 
cgit v1.2.3