diff --git a/README.md b/README.md index 64a44a0..edf66d2 100644 --- a/README.md +++ b/README.md @@ -35,16 +35,19 @@ no one is liable if this software breaks, deletes, corrupts, or ruins anything **note**: if you have chicken scheme installed, then you can install the eggs above by running `make dependencies` as root. -## compilation +## quickstart -chicken scheme runs faster if it's compiled to a binary file. by default, the -binary is named `repo2html`, and is installed in `/usr/local/bin`. - -to compile repo2html into a binary file, follow the steps below: - -1. ensure you're in the repo2html git repository -2. as root, run `make dependencies` -3. run `make` +1. ensure you've set up a web directory and have replaced the + `REPO2HTML_PREFIX` value in the `post-receive` and `git-daemon.service` + files +2. you've created a `git` user, and are logged in as the `git` user +3. as root, run `make dependencies` +4. run `make` +5. as root, run `make install` +6. run `mkdir ~/projects && git init --bare my-repository` +7. run `cp post-receive ~/projects/my-repository/hooks/` +8. run `chmod u+x ~/projects/my-repository/hooks/post-receive` +9. run `cp git-daemon.service /etc/systemd/system/` ## server setup @@ -65,14 +68,14 @@ this section assumes the following about your server: ensure you're in the repo2html git repository, and follow the steps below: 1. as root, run `adduser git` -2. as root, run `mkdir /var/www/git` -3. as root, run `chown git:git /var/www/git` -4. as root, run `ufw allow 9418` -5. run `su git` -6. run `mkdir ~/.ssh && chmod 700 ~/.ssh` -7. run `touch ~/.ssh/authorized_keys && chmod 600 ~/.ssh/authorized_keys` -8. add your public ssh key from your local machine to `~/.ssh/authorized_keys` -9. run `mkdir -p ~/projects/my-repository` +2. as root, run `mkdir /var/www/git && chown git:git /var/www/git` +3. as root, run `ufw allow 9418` +4. run `su git` +5. run `mkdir ~/.ssh && chmod 700 ~/.ssh` +6. run `touch ~/.ssh/authorized_keys && chmod 600 ~/.ssh/authorized_keys` +7. add your public ssh key from your local machine to `~/.ssh/authorized_keys` +8. run `mkdir ~/projects` +9. run `git init --bare my-repository` ### setting up nginx @@ -89,7 +92,18 @@ ensure you're in the repo2html git repository, and follow the steps below: 4. as root, run `certbot`, and follow the prompts 5. as root, run `systemctl restart nginx` -## installation +### compilation + +chicken scheme runs faster if it's compiled to a binary file. by default, the +binary is named `repo2html`, and is installed in `/usr/local/bin`. + +to compile repo2html into a binary file, follow the steps below: + +1. ensure you're in the repo2html git repository +2. as root, run `make dependencies` +3. run `make` + +### installation ensure you're in the repo2html git repository, and follow the steps below: