diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 101 |
1 files changed, 0 insertions, 101 deletions
diff --git a/README.md b/README.md deleted file mode 100644 index b2935b8..0000000 --- a/README.md +++ /dev/null | |||
| @@ -1,101 +0,0 @@ | |||
| 1 | AnonymousSSH | ||
| 2 | ------------ | ||
| 3 | |||
| 4 | |||
| 5 | |||
| 6 | |||
| 7 | |||
| 8 | |||
| 9 | WHAT IT DOES | ||
| 10 | ------------ | ||
| 11 | |||
| 12 | This repository contains the code to share itself (the repository) | ||
| 13 | through Git-over-SSH. | ||
| 14 | |||
| 15 | It also contains the code to listen for changes sent to itself through | ||
| 16 | Git-over-SSH. | ||
| 17 | |||
| 18 | |||
| 19 | |||
| 20 | |||
| 21 | |||
| 22 | |||
| 23 | HOW IT WORKS | ||
| 24 | ------------ | ||
| 25 | |||
| 26 | Git contains a program `git-receive-pack` which implements a git | ||
| 27 | protocol server. The `git-receive-pack` expects to be launched as an SSH | ||
| 28 | server "ForcedCommand" in a configuration that protects the server from | ||
| 29 | untrustworthy users. | ||
| 30 | |||
| 31 | Normally, the SSH server only permits users who have already uploaded | ||
| 32 | their public keys to the server. It assumes that access should be closed | ||
| 33 | to new users. | ||
| 34 | |||
| 35 | Installing this code reverses that assumption, granting open access to | ||
| 36 | unrecognized users. This is made safe by limiting write access to a | ||
| 37 | GIT_NAMESPACE over which the user proves global mathematical ownership with | ||
| 38 | their SSH client key. This means that the user cannot overwrite anyone else's | ||
| 39 | data. | ||
| 40 | |||
| 41 | The user's uploaded data is still saved and is ready to be be merged into the | ||
| 42 | main repository manually, or even automatically. | ||
| 43 | |||
| 44 | |||
| 45 | |||
| 46 | |||
| 47 | |||
| 48 | HOW TO INSTALL | ||
| 49 | -------------- | ||
| 50 | |||
| 51 | Run: | ||
| 52 | ``` | ||
| 53 | make install | ||
| 54 | ``` | ||
| 55 | |||
| 56 | This installs the `AnonymousAccessCommand` in the current user's home | ||
| 57 | directory. | ||
| 58 | |||
| 59 | Then, if sudo access is available, it enables anonymous access by | ||
| 60 | editing the system `OpenSSH` configuration. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | NON-ROOT INSTALLATION | ||
| 68 | --------------------- | ||
| 69 | |||
| 70 | If sudo access is not available, you can install to a different | ||
| 71 | location: | ||
| 72 | |||
| 73 | ``` | ||
| 74 | make SSH_CONFIG_DIR=.config/ssh \ | ||
| 75 | SSHD_CONFIG_DIR=.config/ssh/config.d \ | ||
| 76 | SSH_LIB_DIR=.local/lib/ssh \ | ||
| 77 | install | ||
| 78 | ``` | ||
| 79 | |||
| 80 | Then you will need to run `OpenSSH` on a non-default port (the default | ||
| 81 | port requires root access). | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | ALTERNATIVE LOCATION OF `AnonymousAccessCommand` | ||
| 89 | ------------------------------------------------ | ||
| 90 | |||
| 91 | It is also possible to choose the location of the | ||
| 92 | `AnonymousAccessCommand` itself: | ||
| 93 | |||
| 94 | ``` | ||
| 95 | make USER_SSH_CONFIG_DIR=$HOME/.config/ssh \ | ||
| 96 | install | ||
| 97 | ``` | ||
| 98 | |||
| 99 | First you would have to make the contents of the installed file | ||
| 100 | `AuthorizedKeysCommand` vary according to that `Makefile` paremeter, by | ||
| 101 | editing `Makefile`. | ||