stagit, go module handling, git hooks

1 files changed, 44 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..eb4aba2
--- /dev/null
+++ b/README
@@ -0,0 +1,44 @@
+These are the scripts that power the server at hhvn.uk
+
+Make*.rc:
+	These scripts automatically populate/depopulate a bin/ directory,
+	essentially managing the existence of any scripts from this repo in $PATH
+
+dkim:
+	These scripts are resposible for Domain Key management.
+	- lscert:         lists existing DKIM keypais
+	- mkcert:         generates new DKIM keypairs
+	- rmcert:         removes a DKIM keypair
+	- purge:          automatically removes old DKIM keypairs
+	- reconfig-dns:   adds a DKIM keypair to a DNS zone file
+	- reconfig-smtpd: reconfigures the smtpd.conf filters to use a DKIM keypair
+	- update:         automatically calls other scripts to generate, purge, and reconfig
+
+dns/zone:
+	These scripts make DNS zone editing simpler
+	- edit:   attempts to find a zone and calls $EDITOR
+	- reload: attempts to find, and reload a zone, but checking it over first
+
+tls:
+	These scripts make acme-client easier to access
+	- edit: calls $EDITOR on acme-client.conf
+	- run:  guesses domain and runs acme-client
+
+www/chroot:
+	These scripts manage / exist in the /var/www chroot
+	- mkchroot:    copies binaries + libraries to /var/www
+	- git-wrapper: wraps around git for CGI access
+
+www/generate/src:
+	These scripts generate content in /var/www/htdocs/src.hhvn.uk
+	- gomod:  generates go.mod glue code
+	- stagit: calls stagit
+
+repo:
+	These scrips manage /var/git
+	- mkrepo:  initializes a new repository and returns `git origin` commands
+	- mkhooks: intalls hooks into all repos in /var/git
+
+repo/hooks:
+	These scripts are installed by repo/mkhooks
+	- post-receive: calls www/generate/src/*