add systemd service, makefile, improve INSTALL

1 files changed, 35 insertions, 6 deletions

diff --git a/INSTALL b/INSTALL
index 97b0935..9031c27 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,14 +1,43 @@
-First install Haskell's stack tool, the readline and argon2
+## Quick installation
+
+This installs keysafe to ~/.local/bin, and is sufficient to use keysafe
+to back up or restore your private key.
+
+First install Haskell's stack tool, the zlib, g++, readline and argon2
 libraries, and zenity. For example, on a Debian system:
 
-	sudo apt-get install haskell-stack libreadline-dev libargon2-0-dev zenity
+	sudo apt-get install haskell-stack \
+		zlib1g-dev g++ libreadline-dev libargon2-0-dev zenity
 
-Then to build and install keysafe:
+Then to build and install keysafe, run this in the keysafe directory:
 
-	stack install keysafe
+	stack install
 
 Note that there is a manpage, but stack doesn't install it yet.
 
-## Server installation
+## System-wide installation
+
+This installs keysafe in /usr/bin, and includes the man page, systemd
+service file, etc.
+
+Start by installing the dependencies as shown in Quick installation.
+
+Then, in the keysafe directory:
+
+	make
+	sudo make install
+
+## Packaging
+
+You will probably want to use the Makefile.
+Set PREFIX to install to a different location.
+Set BUILDER=cabal to use cabal rather than the default stack to build.
+
+The make install target creates a keysafe user. Use the install-files
+target to avoid doing that at package build time. You may create the
+keysafe user at package install time instead, although it is only used
+by the keysafe server.
 
-useradd --system keysafe
+While keysafe ships with a systemd service file, distributions should 
+not enable it to be started by default. (Or can put it in its own
+keysafe-server package.)