Updated documentation

1 year ago · 6c5aab9051
2 changed files with 35 additions and 2 deletions
--- a/2
+++ b/2
@ -1,4 +1,4 @@
-MIT License Copyright (c) <year> <copyright holders>
+MIT License Copyright (c) 2020 Christian Aust

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
--- a/README.md
+++ b/README.md
@ -1,2 +1,35 @@
-# dockerfiles
+# Docker file collection

+I run a number of applications using [Docker](https://docs.docker.com/engine/) and [Docker compose](https://docs.docker.com/compose/). These are the docker-compose files used to orchestrate my services.
+
+* `daemsing` a CMS website based on Ruby and the [comfortable mexican sofa CMS system](https://github.com/comfy/comfortable-mexican-sofa)
+* `drone` my CI/CD installation of [drone.io](https://drone.io)
+* `isso` a comment system to go with my static website, based on [isso](https://posativ.org/isso/)
+* `matomo` the [Matomo](https://matomo.org) statistics software
+* `nextcloud` my [Nextcloud](https://nextcloud.com) instance on Docker
+* `software-berater` my static website [software-berater.net](https://software-berater.net)
+
+In order to use the services, clone this repo into `/opt/dockerfiles`.
+
+## systemd integration
+
+In order to have my apps started at boot time, there's a [systemd template](https://fedoramagazine.org/systemd-template-unit-files/) config for it. In order to use it, you need to run this command first:
+
+    ln -s /opt/dockerfiles/dc@.service /etc/systemd/system/dc@.service
+
+After that you can use standard `systemctl` commands to control all services by their base directory name:
+
+```
+# enable the service daemsing
+systemctl enable dc@daemsing
+
+# disable the service drone
+systemctl disable dc@drone
+
+# start the service nextcloud
+systemctl start dc@nextcloud
+```
+
+## Application secrets
+
+Some apps require base passwords or other secrets set from the environment. Usually this should mean [.env files for docker-compose](https://docs.docker.com/compose/environment-variables/#the-env_file-configuration-option) in case I did not forget to provide a template. But I try. :-)