diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 73 |
1 files changed, 33 insertions, 40 deletions
@@ -1,24 +1,24 @@ -This repository contains 4 things: +This repository contains information about Parabola contributors. - 1. Information about Parabola contributors - 2. `Makefile` and `bin/`: tools for working with that information - 3. `misc/git-shell-commands`: for use with git-shell - 4. `misc/git-hooks`: git hooks +It previously contains programs for working with that information; +they now live at [parabola-hackers][], and programs for use with +`git-shell`; they now live at +[git-meta.git/git-shell-commands][git-shell-commands]. -Honestly, the latter two probably don't belong, but they've always -been in this repository, so I didn't want to just delete them. If you -remove git-shell-hooks in the future, be warned that -/srv/git/git-shell-commands is currently a symlink to there; you'll -want to change that. +[parabola-hackers]: https://git.parabola.nu/packages/parabola-hackers.git/ +[git-shell-commands]: https://git.parabola.nu/git-meta.git/tree/git-shell-commands Adding users ============ Users ("hackers") are added by creating a file in the `users/` directory. The file should be named `users/${UID}.yml` where UID is -the numeric POSIX user ID for that user. See -`bin/meta-normalize-stdio` for a listing of all the properties you can -put in the users file; or look at the existing files as examples. +the numeric POSIX user ID for that user. See [meta-normalize-stdio][] +(part of the `parabola-hackers` package) for a listing of all the +properties you can put in the users file; or look at the existing +files as examples. + +[meta-normalize-stdio]: https://git.parabola.nu/packages/parabola-hackers.git/tree/bin/meta-normalize-stdio To add a profile image of a user, add it to the `dev-imgs/` folder. @@ -27,39 +27,32 @@ Images in `dev-imgs/`: - SHOULD be 125x125 px - SHOULD be run through pngcrush -The files in `bin/` are configured with `cfg_*` variables at the top -of each file. - -Using the tools (make) -====================== +Doing things with the documentation +=================================== -There are 4 `make` targets of interest: `pacman-keyring`, `dist`, -`upload` and `postfix-virtual-map`. `make [all]` makes `pacman-keyring` -and`postfix-virtual-map`. The output goes in -`output/{pacman-keyring,postfix-virtual-map}` respectively. +The `parabola-hackers` package contains several programs for doing +things with the data in this repository. You should install it. -`pacman-keyring` makes the Pacman keyring that we package up as the -`parabola-keyring` package. +For fuller documentation, see the README of [parabola-hackers][]. +But, here some simple commands that you are likely interested in. -`dist` makes the `parabola-keyring` tarball. +Firstly, before using any of these commands, you need to tell them +where to find the files: -`upload` makes the uploading of `parabola-keyring` tarball to the server. + export PARABOLA_HACKERS_YAMLDIR=/path/to/hackers-git/users + +where `/path/to/hackers-git` is the directory containing this README +file. Alternatively, you may set `yamldir` in +`/etc/parabola-hackers.yml` (the environment variable takes precedence +over the config file). -`postfix-virtual-map` makes a map for postfix email aliases we provide -to our developers. +Check the integrity and formatting of the files: -Using the tools (scripts) -========================= - -Most of the scripts assume that the current directory is the root of + /usr/lib/parabola-hackers/meta-check + +PLEASE, PLEASE, OH PLEASE: run the above command before committing to this repository. -The most important 3 scripts are: - - - `meta-check`: sanity-check the user data - - `meta-normalize-stdio`: normalize a user YAML file - - `ssh-list-authorized-keys`: configure sshd to use this for - AuthorizedKeysCommand to have it get SSH keys directly from the - user data here +Create a tarball to be the source of the parabola-keyring package: -The others are all used by `make`. + /usr/lib/parabola-hackers/pacman-make-keyring V=$(date -u +%Y%m%d) |