Debian: Install default configuration with comments

diff --git a/debian/rules b/debian/rules
index 634318253124a8084f13f2803d5e2e5302d4248f..721c054cc95f9553cddffaddce92988569b493a5 100755 (executable)
--- a/debian/rules
+++ b/debian/rules
@@ -22,6 +22,6 @@ override_dh_auto_configure:
        ./configure PREFIX=/usr
 
 override_dh_auto_install:
-       make DESTDIR=debian/subauth install-server install-client
+       make DESTDIR=debian/subauth INSTALL_CONFIG_DIR=/etc install-server
+       make DESTDIR=debian/subauth install-client
        make DESTDIR=debian/libpam-subauth INSTALL_LIB_DIR=/lib/$(DEB_HOST_MULTIARCH) install-pam
-###    make DESTDIR=debian/libapache2-mod-subauth install-apache

diff --git a/etc/subauthd b/etc/subauthd
index 6f92259e3b0f08955cf65c9d73d5b22160712be2..4e42a470ef5d5a34ee2273816e43ebe13f01e917 100644 (file)
--- a/etc/subauthd
+++ b/etc/subauthd
@@ -1,20 +1,40 @@
 SubauthD {
+       # Path to local socket over which clients communicate with the daemon
        SocketPath      @INSTALL_RUN_DIR@/subauthd.socket
-       MaxConnections  1000
+
+       # Path to database of users and accounts
        Database        @INSTALL_STATE_DIR@/subauthd.db
+
+       # An optional path to a key for signing temporary tokens.
+       # If it is defined, temporary tokens survive daemon restart. Otherwise,
+       # the daemon creates a new key on every startup.
        TempKeyFile     @INSTALL_STATE_DIR@/subauthd-temp-key
 
+       # Maximum number of simultaneous client connections
+       MaxConnections  1000
+
+       # Authentication zones: each zone contains accounts for local users
+       # (at most one per user), zones are completely independent.
        Zone {
+               # Name of the zone
                Name            mail
+
+               # One-line description
                Description     E-mail
+
+               # Allow automatic creation of accounts: when a user tries to create
+               # a password/token in a zone where he has no account, the account is
+               # created. If turned off, all accounts must be created explicitly
+               # by the super-user.
                AutoCreateAcct  1
+
+               # Allow users to set a password
                AllowPasswd     1
+
+               # Allow users to create a token, set maximum number of tokens per user
                AllowTokens     16
-               MaxTempValidity 3600
-       }
 
-       Zone {
-               Name            web
-               AllowPasswd     1
+               # Allow users to create a temporary token, set maximum lifetime of such token
+               MaxTempValidity 3600
        }
 }

diff --git a/server/Makefile b/server/Makefile
index 68f6d1b20f666e27628a5927c5ad59d4f4e8b6cb..9ce2354d78407cc4bbec1cd0de6ebfc9bb5c09b1 100644 (file)
--- a/server/Makefile
+++ b/server/Makefile
@@ -10,5 +10,6 @@ $(o)/server/auth.o: CFLAGS+=$(LIBGCRYPT_CFLAGS)
 .PHONY: install-server
 install:: install-server
 install-server:
-       install -d -m 755 $(DESTDIR)$(INSTALL_SBIN_DIR)
+       install -d -m 755 $(DESTDIR)$(INSTALL_SBIN_DIR) $(DESTDIR)$(INSTALL_CONFIG_DIR)
        install -m 755 $(o)/server/subauthd $(DESTDIR)$(INSTALL_SBIN_DIR)
+       install -m 644 run/etc/subauthd $(DESTDIR)$(INSTALL_CONFIG_DIR)