Implement allow_interactive feature

[repo_shell.git] / README

diff --git a/README b/README
index 14db116d35606c399de95841e6275edc0a4cedbd..8a5db3ab9179952fbd82414d8aadaf7bddc5fa76 100644 (file)
--- a/README
+++ b/README
@@ -27,12 +27,14 @@ Please build from a repository clone, as the make script uses
 
 = Configure /etc/repo_shell.cfg
 
-The file /etc/repo_shell.cfg must contain certain fields:
+The file /etc/repo_shell.cfg must contain certain fields as shown in the example
+below.  The spaces surrounding the equal sign ('=') are optional.
 
-    owner=repo
-    svn_root=/var/lib/svn/repositories
-    git_root=/var/lib/git
-    git_acl_file=/var/lib/git/.gitacls
+    owner = repo
+    svn_root = /var/lib/svn/repositories
+    git_root = /var/lib/git
+    git_acl_file = /var/lib/git/.gitacls
+    allowed_interactive =
 
 owner is the system account username which will own all repositories, and is
 preferaby a system account used for no other purpose.  Use the adduser or
@@ -46,6 +48,13 @@ git_acl_file is the pathname of a file providing ACL information for git
 repository access, as implemented internally bit repo_shell.  A recommended
 pathname is /var/lib/git/.gitacls
 
+allow_interactive contains a list of users that may log into the server via SSH,
+or that may issue arbitrary commands to the server via SSH.  Instead of a list,
+the wildcard character '*' can be used to indicate all users.  Note that this
+only affects users that have /usr/local/bin/repo_shell as their login shell.
+If the server is only hosting repositories, there is no reason for users to be
+allowed 'interactive' access.
+
 = Create owner and paths
 
 In accordance with the contents of /etc/repo_shell.cfg: