From 71d846c84b47109830bdb7a484810bc4640a0179 Mon Sep 17 00:00:00 2001 From: Andrew Cady Date: Sat, 23 Oct 2021 11:59:03 -0400 Subject: README --- README.txt | 109 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 108 insertions(+), 1 deletion(-) diff --git a/README.txt b/README.txt index a1c0dd8..e65cdbe 100644 --- a/README.txt +++ b/README.txt @@ -1 +1,108 @@ -minimal rhizome +WHAT IT DOES +------------ + +This repository contains the code to share itself through Git-over-SSH. + +It also contains the code to listen for changes sent to itself through +Git-over-SSH. + + + + +. +. +. +. +. +. + + + +HOW IT WORKS +------------ + +Git contains a program `git-receive-pack` which implements a git protocol +server. The `git-receive-pack` expects to be launched as an SSH server +"ForcedCommand" in a configuration that protects the server from untrustworthy +users. + + + +. +. +. +. +. +. +HOW TO INSTALL +-------------- + + +Run: + + + make + + + +This installs the `AnonymousAccessCommand` in the current user's home directory. + +Then, if sudo access is available, it enables anonymous access by editing the +system `OpenSSH` configuration. + + + +. +. +. +. +. +. + + + +NON-ROOT INSTALLATION +--------------------- + +If sudo access is not available, you can install to a different location: + +``` + make SSH_CONFIG_DIR=.config/ssh \ + SSHD_CONFIG_DIR=.config/ssh/config.d \ + SSH_LIB_DIR=.local/lib/ssh +``` + +Then you will need to run `OpenSSH` on a non-default port (the default port +requires root access). + + + +. +. +. +. +. +. + + + +ALTERNATIVE LOCATION OF `AnonymousAccessCommand` +------------------------------------------------ + +It is also possible to choose the location of the `AnonymousAccessCommand` itself: + +``` + make USER_SSH_CONFIG_DIR=/.config/ssh +``` + +First you will have to make `AuthorizedKeysCommand` vary according to that +paremeter. + + + + + + + + + -- cgit v1.2.3