diff options
author | Wojtek Kosior <koszko@koszko.org> | 2022-11-21 20:25:17 +0100 |
---|---|---|
committer | Wojtek Kosior <koszko@koszko.org> | 2022-11-21 20:25:17 +0100 |
commit | b13a2e76f34b09881067c16a36f4ddbd1f61a7e1 (patch) | |
tree | 58133f85dd5b11e1658f4939c2c9a1b35d164041 | |
parent | f4cdf84714f7ddba795b20640d1390721871a5b0 (diff) | |
download | koszko-org-server-b13a2e76f34b09881067c16a36f4ddbd1f61a7e1.tar.gz koszko-org-server-b13a2e76f34b09881067c16a36f4ddbd1f61a7e1.zip |
briefly document container use and installation in `Makefile`
-rw-r--r-- | README.md | 51 |
1 files changed, 51 insertions, 0 deletions
@@ -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. |